{ "openapi": "3.0.1", "info": { "title": "Google Position Checker — Keyword Rank Snapshot", "description": "Check keyword ranking positions from SERP snapshots or approved live SERP collection with country/language options and rank evidence.", "version": "2.3", "x-build-id": "E7L7E1Q0cafgAfVn7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~google-position-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-google-position-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/junipr~google-position-checker/runs": { "post": { "operationId": "runs-sync-junipr-google-position-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/junipr~google-position-checker/run-sync": { "post": { "operationId": "run-sync-junipr-google-position-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "domain": { "title": "Target domain", "type": "string", "description": "Domain to match in supplied organic results. Scheme and www prefix are normalized.", "default": "apify.com" }, "maxPosition": { "title": "Maximum position", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Inspect at most this many organic results per keyword.", "default": 100 }, "matchMode": { "title": "Domain matching", "enum": [ "EXACT_HOST", "HOST_OR_SUBDOMAINS" ], "type": "string", "description": "EXACT_HOST matches only the normalized host. HOST_OR_SUBDOMAINS also matches subdomains.", "default": "HOST_OR_SUBDOMAINS" }, "serpSnapshots": { "title": "SERP snapshots", "minItems": 1, "maxItems": 1000, "type": "array", "description": "One supplied snapshot per keyword. Each snapshot must contain organicResults or suppliedHtml/suppliedText that the runtime parser supports.", "items": { "type": "object", "additionalProperties": false, "properties": { "keyword": { "title": "Keyword", "description": "Keyword represented by this snapshot.", "type": "string" }, "country": { "title": "Country", "description": "Optional country context.", "type": "string", "default": null, "nullable": true }, "language": { "title": "Language", "description": "Optional language context.", "type": "string", "default": null, "nullable": true }, "device": { "title": "Device", "description": "Optional device context.", "type": "string", "default": null, "nullable": true }, "organicResults": { "title": "Organic results", "description": "Ordered organic results from the supplied snapshot.", "type": "array", "default": [], "items": { "type": "object", "additionalProperties": false, "properties": { "position": { "title": "Position", "description": "Organic rank position.", "type": "integer", "minimum": 1 }, "title": { "title": "Title", "description": "Result title.", "type": "string", "default": null, "nullable": true }, "url": { "title": "URL", "description": "Result URL.", "type": "string" } } } }, "suppliedHtml": { "title": "Supplied HTML", "description": "Optional snapshot HTML supplied directly in input.", "type": "string", "default": null, "editor": "textarea", "nullable": true }, "suppliedText": { "title": "Supplied text", "description": "Optional plain-text representation supplied directly in input.", "type": "string", "default": null, "editor": "textarea", "nullable": true } } }, "default": [ { "keyword": "apify web scraper", "country": "us", "language": "en", "device": "desktop", "organicResults": [ { "position": 1, "title": "Web scraping overview", "url": "https://example.org/web-scraping" }, { "position": 2, "title": "Apify Store", "url": "https://apify.com/store" } ] } ] } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }