{ "openapi": "3.0.1", "info": { "title": "Local Map Rank Tracker - Geo-Grid Google Maps Rankings", "description": "Track how a business ranks on Google Maps across a geo-grid of locations. See where you rank #1 and where you drop off, with per-point competitors and visibility scores.", "version": "0.0", "x-build-id": "thsBKNRf2cGxxo1lq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/santhej~local-rank-grid-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-santhej-local-rank-grid-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/santhej~local-rank-grid-tracker/runs": { "post": { "operationId": "runs-sync-santhej-local-rank-grid-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/santhej~local-rank-grid-tracker/run-sync": { "post": { "operationId": "run-sync-santhej-local-rank-grid-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": "Search terms", "type": "array", "description": "Search terms customers use, e.g. 'coffee shop', 'plumber near me'. Each is scanned across the whole grid.", "items": { "type": "string" } }, "businessName": { "title": "Business name to track", "type": "string", "description": "The business whose rank you want to follow across the grid (matched by name)." }, "businessDomain": { "title": "Business website (optional)", "type": "string", "description": "Alternative / additional matcher, e.g. mycafe.com." }, "centerCoordinate": { "title": "Center coordinate (lat,lng)", "type": "string", "description": "Center of the grid as 'latitude,longitude', e.g. 40.7128,-74.0060. Tip: right-click a spot in Google Maps to copy coordinates." }, "gridSize": { "title": "Grid size", "enum": [ "3", "5", "7", "9" ], "type": "string", "description": "Square grid: 3x3=9, 5x5=25, 7x7=49, 9x9=81 points. You are charged per point.", "default": "5" }, "spacingKm": { "title": "Spacing between points (km)", "type": "string", "description": "Distance in kilometres between adjacent grid points. Smaller = tighter local view.", "default": "1.5" }, "zoom": { "title": "Map zoom level", "type": "string", "description": "Google Maps zoom (10-17). Higher = more local results.", "default": "14" }, "competitorsPerPoint": { "title": "Competitors per point", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many top-ranking businesses to capture at each grid point (0-10).", "default": 3 }, "languageCode": { "title": "Language code", "type": "string", "description": "Two-letter language code, e.g. en.", "default": "en" }, "maxBudgetUsd": { "title": "Max budget (USD, optional)", "minimum": 0, "type": "number", "description": "Safety cap. The run aborts before starting if the estimated charge exceeds this." }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "POST each keyword's scan summary here." } } }, "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 } } } } } } } } } }