{ "openapi": "3.0.1", "info": { "title": "Google Maps Geo-Grid Rank Tracker", "description": "See where a Google Business Profile ranks on Google Maps across a grid of points around it. Per-point rank, average rank, top-3 coverage, who ranks ahead and a PNG heatmap. Powered by GeoGridAPI.", "version": "1.0", "x-build-id": "KUOrW6Nr1n1XY80Xa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/geogridapi~google-maps-geogrid-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-geogridapi-google-maps-geogrid-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/geogridapi~google-maps-geogrid-rank-tracker/runs": { "post": { "operationId": "runs-sync-geogridapi-google-maps-geogrid-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/geogridapi~google-maps-geogrid-rank-tracker/run-sync": { "post": { "operationId": "run-sync-geogridapi-google-maps-geogrid-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", "required": [ "businesses", "keywords" ], "properties": { "businesses": { "title": "Businesses", "minItems": 1, "maxItems": 50, "type": "array", "description": "Google Business Profiles to track, one per line. Write the name with its city or street (\"Joe's Pizza, Broadway, New York\"), or paste a Google place ID (ChIJ...).", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "minItems": 1, "maxItems": 20, "type": "array", "description": "Searches to measure, one per line, as a customer would type them in Google Maps (\"pizza\", \"plumber\").", "items": { "type": "string" } }, "shape": { "title": "Grid shape", "enum": [ "square", "circle", "diamond", "hexagon", "cross", "ellipse", "rectangle" ], "type": "string", "description": "Square grids are set by size. Other shapes are set by density, up to 49 points, and points that fall in the sea are skipped and not charged.", "default": "square" }, "gridSize": { "title": "Square grid size", "enum": [ "3", "5", "7", "9" ], "type": "string", "description": "Points per side of a square grid. Ignored for other shapes.", "default": "5" }, "density": { "title": "Density (other shapes)", "enum": [ "low", "medium", "high" ], "type": "string", "description": "How many points fill a circle, diamond, hexagon, cross, ellipse or rectangle. Ignored for square grids.", "default": "medium" }, "radiusKm": { "title": "Radius (km)", "minimum": 0.5, "maximum": 30, "type": "number", "description": "Distance from the business to the edge of the grid, from 0.5 to 30 km (at least 1 km for shapes other than square). Leave empty for the default: 1.5 km for 3 × 3, 2.5 km for 5 × 5, 3.5 km for 7 × 7, 4.5 km for 9 × 9." }, "language": { "title": "Results language", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Two-letter language code of the Google Maps results (\"en\", \"fr\", \"de\"). Leave empty for English." }, "country": { "title": "Country", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Two-letter country code (\"us\", \"fr\") that helps find the right business when its name exists in several countries." }, "includeImage": { "title": "Save a heatmap image", "type": "boolean", "description": "Saves a PNG of each map (Google Maps background, rank on every point) in the key-value store and links it in the results.", "default": true }, "geogridApiKey": { "title": "Your GeoGridAPI key", "type": "string", "description": "Already have GeoGridAPI credits? Paste a key from geogridapi.io: the maps are paid with your credits and this Actor charges no grid points." } } }, "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 } } } } } } } } } }