{ "openapi": "3.0.1", "info": { "title": "Google Rank Tracking for SERP & Maps", "description": "Track a submitted website domain in Google organic results for each keyword, or check a business across a Google Maps grid. Get positions, result details, local competitors, visibility summaries, and coverage status for a chosen country and language.", "version": "0.0", "x-build-id": "mWFTZQ1ae7xj6Pu9w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~google-rank-tracking/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-google-rank-tracking", "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/maximedupre~google-rank-tracking/runs": { "post": { "operationId": "runs-sync-maximedupre-google-rank-tracking", "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/maximedupre~google-rank-tracking/run-sync": { "post": { "operationId": "run-sync-maximedupre-google-rank-tracking", "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", "required": [ "resultType", "keywords" ], "properties": { "resultType": { "title": "Result type", "enum": [ "organic", "local" ], "type": "string", "description": "Choose which result family this run returns. Organic rank tracking checks a domain in Google Search. Local rank tracking checks a business across a Google Maps grid." }, "websiteDomain": { "title": "Website domain", "pattern": "^(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z]{2,63}$", "type": "string", "description": "Enter the domain to track, without https:// or a path. This field is required for Organic rank tracking." }, "organicDepth": { "title": "Organic check depth", "minimum": 1, "type": "integer", "description": "Set how many organic results to check for each keyword. A not-found result means the domain was not seen within this depth.", "default": 100 }, "organicMovementThreshold": { "title": "Movement alert threshold", "minimum": 1, "type": "integer", "description": "Flag an organic change when a repeat check moves by this many positions or more. Use 1 to flag any position change.", "default": 3 }, "localBusinessName": { "title": "Business name", "type": "string", "description": "Enter the public business name to find in Google Maps. This field is required for Local rank tracking." }, "localBusinessAddress": { "title": "Business address", "type": "string", "description": "Add the business address to help match the right Google Maps listing. Leave it blank when the name is enough." }, "localScanCenter": { "title": "Scan center", "required": [ "latitude", "longitude" ], "type": "object", "description": "Set the center of the local grid with latitude and longitude in decimal degrees. Example: {\"latitude\": 40.7128, \"longitude\": -74.0060}.", "properties": { "latitude": { "title": "Latitude", "type": "number", "description": "Latitude in decimal degrees, from -90 to 90.", "minimum": -90, "maximum": 90 }, "longitude": { "title": "Longitude", "type": "number", "description": "Longitude in decimal degrees, from -180 to 180.", "minimum": -180, "maximum": 180 } } }, "localScanRadiusKm": { "title": "Grid radius (km)", "minimum": 0.1, "type": "number", "description": "Set how far the grid reaches from the scan center, in kilometers.", "default": 5 }, "localGridResolution": { "title": "Grid resolution", "enum": [ "3x3", "5x5", "7x7" ], "type": "string", "description": "Choose how many points each side of the local grid has. A 5 by 5 grid checks 25 points.", "default": "5x5" }, "localPrioritization": { "title": "Prioritize local findings by", "enum": [ "opportunity", "visibility", "competition" ], "type": "string", "description": "Choose what the local market report puts first: opportunity areas, local visibility, or competition.", "default": "opportunity" }, "keywords": { "title": "Keywords", "minItems": 1, "type": "array", "description": "Enter one or more search terms. Organic rank tracking checks the domain for each keyword. Local rank tracking checks the business at each grid point for each keyword.", "items": { "type": "string" } }, "countryCode": { "title": "Google country", "pattern": "^[A-Z]{2}$", "type": "string", "description": "Enter a two-letter ISO 3166-1 country code, such as US. This sets the Google country context for every check.", "default": "US" }, "languageCode": { "title": "Google language", "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z]{2,4})?$", "type": "string", "description": "Enter a language code such as en or fr. Use a language-region code such as en-US when needed.", "default": "en" } } }, "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 } } } } } } } } } }