{ "openapi": "3.0.1", "info": { "title": "Local AI Visibility Tracker: ChatGPT, Perplexity & Maps", "description": "Track ChatGPT, Perplexity, Gemini, Claude and readable Google AI recommendations for your business and city. Get Maps matches, competitors, citations, review gaps, an HTML report and history. $0.10 per analysed answer plus model usage.", "version": "0.1", "x-build-id": "VNGdtMffegFq5Z3yd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~local-ai-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-local-ai-visibility", "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~local-ai-visibility/runs": { "post": { "operationId": "runs-sync-zaiq-local-ai-visibility", "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~local-ai-visibility/run-sync": { "post": { "operationId": "run-sync-zaiq-local-ai-visibility", "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": { "businessName": { "title": "Business name", "type": "string", "description": "The local business to monitor. Give its name and city, or use its Google Maps URL. Names are matched conservatively." }, "city": { "title": "City", "type": "string", "description": "City with region where useful, such as Austin, Texas. Required with a business name. A precise Maps link can supply the city." }, "googleMapsUrl": { "title": "Google Maps URL", "type": "string", "description": "Optional precise place link. A single listing supplies the name and city when they are not entered." }, "services": { "title": "Services", "type": "array", "description": "What the business sells. Each service combines with the selected places and intent templates. Up to 10.", "items": { "type": "string" } }, "places": { "title": "City or neighbourhoods", "type": "array", "description": "Optional neighbourhoods within the city, up to 10. The city is appended to keep neighbourhood names unambiguous. Empty uses the city.", "items": { "type": "string" }, "default": [] }, "intents": { "title": "Question intents", "type": "array", "description": "Templates for generated questions. Emergency and open-now intents should be used only for relevant services. Use Prompts to edit the wording.", "items": { "type": "string", "enum": [ "best", "emergency", "problem", "budget", "open-now" ], "enumTitles": [ "Best service", "Emergency service", "Who to call for a problem", "Lowest price", "Open now" ] }, "default": [ "best" ] }, "problems": { "title": "Problems customers need solved", "type": "array", "description": "Problems for the problem intent, such as a leaking pipe. Required when that intent is selected. Up to 10.", "items": { "type": "string" }, "default": [] }, "competitors": { "title": "Competitor names", "type": "array", "description": "Optional businesses to track alongside yours. When empty, use the top local Maps results for each service and place. Recommendations are extracted independently of this list.", "items": { "type": "string" }, "default": [] }, "businessAliases": { "title": "Business name variants", "type": "array", "description": "Exact alternate names used for your business. Do not use generic service words. Up to 10.", "items": { "type": "string" }, "default": [] }, "engines": { "title": "AI engines", "type": "array", "description": "API models with web search; these are not signed-in consumer app sessions. Google AI requires readable SERP-page answers; AI Mode may be unavailable and then produces free notes.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini", "claude", "google-ai-overview", "google-ai-mode" ], "enumTitles": [ "ChatGPT (OpenAI API)", "Perplexity", "Gemini", "Claude", "Google AI Overview", "Google AI Mode (availability varies)" ] }, "default": [ "perplexity" ] }, "language": { "title": "Language", "type": "string", "description": "Language code for answers and Google pages, such as en, de or pt-BR. Generated templates are English; use explicit prompts for native-language phrasing.", "default": "en" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code for approximate model search location, Maps and Google pages. It does not set GPS coordinates.", "default": "US" }, "prompts": { "title": "Prompts (replace generated questions)", "type": "array", "description": "Optional exact customer questions. When present, these replace the services × places × intent templates. Generated questions are listed in SUMMARY for editing. Up to 100.", "items": { "type": "string" }, "default": [] }, "extraPrompts": { "title": "Extra prompts", "type": "array", "description": "Additional customer questions, appended to generated or explicit prompts. Up to 20.", "items": { "type": "string" }, "default": [] }, "historyStore": { "title": "Named history store", "type": "string", "description": "Optional key-value store name, using letters, digits and hyphens. Schedule runs sequentially with the same questions and models for comparable changes. Incomplete runs keep the previous complete baseline." }, "competitorsPerSearch": { "title": "Automatic competitors per search", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of local Maps results to include as tracked competitors for each service/place query.", "default": 5 }, "maxAnswers": { "title": "Maximum analysed answer attempts", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum question × engine combinations to attempt, in prompt order then engine order. Failures are free. Model usage is billed separately.", "default": 10 }, "maxAnswerTokens": { "title": "Answer token limit", "minimum": 500, "maximum": 2048, "type": "integer", "description": "Answering-model output limit. The gateway supports up to 2048. Truncated or refused answers produce free notes.", "default": 1600 }, "openaiModel": { "title": "ChatGPT model ID (optional)", "type": "string", "description": "Leave empty to select the newest model in the supported family from the gateway catalog. Set the same model for stable scheduled comparisons." }, "perplexityModel": { "title": "Perplexity model ID (optional)", "type": "string", "description": "Leave empty to select the newest model in the supported family from the gateway catalog. Set the same model for stable scheduled comparisons." }, "geminiModel": { "title": "Gemini model ID (optional)", "type": "string", "description": "Leave empty to select the newest model in the supported family from the gateway catalog. Set the same model for stable scheduled comparisons." }, "claudeModel": { "title": "Claude model ID (optional)", "type": "string", "description": "Leave empty to select the newest model in the supported family from the gateway catalog. Set the same model for stable scheduled comparisons." } } }, "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 } } } } } } } } } }