{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Tracker — AI Overviews, ChatGPT, Gemini", "description": "AI Search Visibility Tracker: check if your brand is mentioned and cited in Google AI Overviews (no key needed) and in ChatGPT, Perplexity and Gemini with your own API keys. Get mention position, cited URLs, share of voice vs competitors, answer text and Google top 10. Pay per check.", "version": "1.0", "x-build-id": "9jElRObgaNeMmvzl4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/intelscrape~ai-search-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-intelscrape-ai-search-visibility-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/intelscrape~ai-search-visibility-tracker/runs": { "post": { "operationId": "runs-sync-intelscrape-ai-search-visibility-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/intelscrape~ai-search-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-intelscrape-ai-search-visibility-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": [ "prompts", "brandName" ], "properties": { "prompts": { "title": "Prompts / questions", "type": "array", "description": "Questions your customers ask AI search, one per line (up to 500).", "items": { "type": "string" } }, "brandName": { "title": "Your brand", "type": "string", "description": "Brand name to look for in AI answers." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other names or product names, e.g. 'HubSpot CRM'.", "default": [], "items": { "type": "string" } }, "brandDomains": { "title": "Brand domains", "type": "array", "description": "Your website domains, used to detect when AI cites you as a source.", "default": [], "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names or domains for share of voice.", "default": [], "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Google AI Overviews works out of the box. ChatGPT, Perplexity and Gemini need your own API key below (billed to your account).", "items": { "type": "string", "enum": [ "google_ai_overview", "openai", "perplexity", "gemini" ], "enumTitles": [ "Google AI Overviews (no key needed)", "ChatGPT / OpenAI with web search (your key)", "Perplexity Sonar (your key)", "Gemini with Google Search grounding (your key)" ] }, "default": [ "google_ai_overview" ] }, "country": { "title": "Country (Google)", "type": "string", "description": "Two-letter country code for Google AI Overviews.", "default": "us" }, "language": { "title": "Language (Google)", "type": "string", "description": "Interface language for Google.", "default": "en" }, "openaiApiKey": { "title": "Your OpenAI API key", "type": "string", "description": "Enables ChatGPT (Responses API with web search)." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Model used with the web_search tool.", "default": "gpt-4.1-mini" }, "perplexityApiKey": { "title": "Your Perplexity API key", "type": "string", "description": "Enables Perplexity Sonar." }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "sonar, sonar-pro...", "default": "sonar" }, "geminiApiKey": { "title": "Your Gemini API key", "type": "string", "description": "Enables Gemini with Google Search grounding." }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Gemini model name.", "default": "gemini-2.5-flash" }, "includeAnswerText": { "title": "Include full answer text", "type": "boolean", "description": "Save the AI answer text with each check.", "default": 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 } } } } } } } } } }