{ "openapi": "3.0.1", "info": { "title": "Google Rank Tracker: Positions, Competitors & AI Overviews", "description": "Track keyword positions for your site and competitors across countries, cities and devices. Get ranking changes, SERP features, AI Overview citations, ads, share of voice and a client-ready HTML report. Named stores keep comparable history.", "version": "0.1", "x-build-id": "CyLMa5WfR5nmQQd7c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~google-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-google-rank-tracker", "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/zaiq~google-rank-tracker/runs": { "post": { "operationId": "runs-sync-zaiq-google-rank-tracker", "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/zaiq~google-rank-tracker/run-sync": { "post": { "operationId": "run-sync-zaiq-google-rank-tracker", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "1–1,000 search phrases. One row per unique keyword. Empty input uses the prefilled example.", "items": { "type": "string" }, "default": [] }, "targetDomains": { "title": "Your site and competitors", "type": "array", "description": "1–20 domains. Your site first, then competitors. No URL paths. www is treated as the same host. Replace the example domains with yours.", "items": { "type": "string" }, "default": [] }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code, for example US, GB, DE, ZA or AU. See README for supported countries. gl is a country preference, not proof of physical location.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Interface language code, such as en or de. Blank uses the usual language of the country.", "default": "" }, "city": { "title": "City (optional)", "type": "string", "description": "Google canonical location name: City,Region,Country. Must end with the selected country name. Missing or different observed city labels get one retry; still-unverified pages are free and do not update history.", "default": "" }, "device": { "title": "Device", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Requests the desktop or mobile results page. Both have separate ranking history.", "default": "desktop" }, "depth": { "title": "Tracking depth", "enum": [ "10", "20", "30", "50", "100" ], "type": "string", "description": "Google serves pages of up to 10. Each additional successfully checked page is charged separately; failed pages are free. Features are measured on page one.", "default": "10" }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "On: example.com includes blog.example.com. Off: exact host only. www is always folded into its parent; sub.example.com never matches its parent.", "default": true }, "trackingStore": { "title": "Tracking store (optional)", "type": "string", "description": "Named key-value store for history, 1–63 letters, numbers and hyphens. Reuse the name on schedules. Do not run overlapping jobs against the same store. Leave blank for a single check.", "default": "" }, "checkAiOverview": { "title": "Check AI Overviews", "type": "boolean", "description": "Read the overview and citation links already present in the results page. No model call or AI fee. A deferred overview is reported as unknown, not absent.", "default": true }, "maxConcurrency": { "title": "Concurrent keyword checks", "minimum": 1, "maximum": 8, "type": "integer", "description": "Check 1–8 keywords at once (default 6). Pages for one keyword stay in order. Lower this when the source rate-limits requests; spending reservations apply before work starts.", "default": 6 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }