{ "openapi": "3.0.1", "info": { "title": "Google Maps Geogrid Rank Tracker β€” Local Rank Heatmap", "description": "Track a business's Google Maps search rank at every point of a 3x3 to 13x13 grid for up to 20 keywords. Rank 1-20 per point with the top 3 competitors, ARP, ATRP, Share of Local Voice, a heatmap and changes since your last scan.", "version": "0.1", "x-build-id": "05RnYJBOYb2C1wtrB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~google-maps-geogrid-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-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/yugenox~google-maps-geogrid-rank-tracker/runs": { "post": { "operationId": "runs-sync-yugenox-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/yugenox~google-maps-geogrid-rank-tracker/run-sync": { "post": { "operationId": "run-sync-yugenox-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": [ "business", "keywords" ], "properties": { "business": { "title": "🏒 Business", "type": "string", "description": "The business to track. Best: its Google Maps link (open the business on Google Maps and copy the link, or a maps.app.goo.gl share link), its place ID (ChIJ…) or its CID. These are exact: the business is then recognised at every point by Google's own ID, never by name. Fallback: \"Name, full address\" β€” looked up once and used only when both the name and the address match (otherwise the run stops and lists the closest businesses with their place IDs)." }, "keywords": { "title": "πŸ” Keywords", "maxItems": 20, "type": "array", "description": "What customers type into Google Maps, one per line (1-20), e.g. \"dentist\", \"emergency dentist\", \"teeth whitening\". Every keyword is searched at every grid point.", "items": { "type": "string" } }, "gridSize": { "title": "πŸ”² Grid size", "minimum": 3, "maximum": 13, "type": "integer", "description": "Points per side: 3, 5, 7, 9, 11 or 13 (3 = 9 points, 7 = 49 points, 13 = 169 points). Each point is one search per keyword. Other numbers are rounded to the nearest of these.", "default": 7 }, "radius": { "title": "πŸ“ Radius", "minimum": 0.1, "maximum": 50, "type": "number", "description": "Distance from the grid center to the middle of its edge (the grid is 2 x radius wide). Points are evenly spaced: a 7 x 7 grid with a 3 km radius puts points 1 km apart. Typical: 1-2 km for a dense city, 5-15 km for a service area.", "default": 3 }, "radiusUnit": { "title": "Radius unit", "enum": [ "km", "mi" ], "type": "string", "description": "Kilometers or miles.", "default": "km" }, "gridShape": { "title": "⬛ Grid shape", "enum": [ "square", "circle" ], "type": "string", "description": "Square: every point of the grid. Circle: only points within the radius of the center (the corners are skipped, so fewer points to pay for).", "default": "square" }, "gridCenter": { "title": "πŸ“ Grid center", "type": "string", "description": "\"latitude, longitude\" of the grid's center, e.g. \"43.6532, -79.3832\". Leave empty to center the grid on the business itself." }, "monitorMode": { "title": "πŸ“ˆ Monitor mode", "type": "boolean", "description": "Compare with the previous scan of the same business, keyword and grid: every point gets its previous rank and how it moved (up / down / entered / dropped), every summary gets the change in ARP, ATRP, Share of Local Voice and found share. Scans are kept in a key-value store in your account (\"geogrid-rank-monitor\"). Run it on a schedule (weekly or monthly) to track progress. Changes are free.", "default": false }, "competitorsPerKeyword": { "title": "πŸ₯Š Competitors per keyword", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many competitor rows to save per keyword: the businesses that show up most often in the top 3 across the grid, with their ARP, ATRP and Share of Local Voice. 0 = none. Competitor rows are free.", "default": 10 }, "language": { "title": "πŸ—£οΈ Language", "type": "string", "description": "Google Maps interface language (hl), e.g. en, fr, es, de. Affects category names, not ranks.", "default": "en" }, "country": { "title": "🌍 Country", "type": "string", "description": "Two-letter country code Google Maps searches as (gl), e.g. us, ca, gb. Leave empty to use the business's own country." }, "searchAreaKm": { "title": "πŸ”­ Search area per point (km)", "minimum": 0.5, "maximum": 30, "type": "number", "description": "Width of the map view each point searches from. Empty = automatic: 2 x the distance between points, between 2 and 15 km, so every point ranks the businesses around it rather than the whole city. Only change it if you know you need a wider or tighter view (0.5-30 km)." }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Key-value store (in your account) that keeps previous scans for monitor mode. Use a different name to keep separate histories, e.g. per client. Only a-z, 0-9 and \"-\".", "default": "geogrid-rank-monitor" }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy", "type": "object", "description": "Apify datacenter proxies work for Google Maps (and are the cheapest). Points Google doesn't answer are retried after a network or server error and never charged; a bot check stops the run. Only Apify datacenter groups are used: residential or SERP groups are replaced by datacenter (they would cost more per point than the point itself).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }