{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Tracker: ChatGPT, Perplexity, Gemini", "description": "Check if ChatGPT, Perplexity and Gemini mention or cite your brand for any list of prompts. Get position, competitors named, cited sources and a 0 to 100 visibility score per engine. Bring your own API keys.", "version": "1.0", "x-build-id": "TUoPj5GvTi1yqjciw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pistachio_implementation~ai-search-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pistachio_implementation-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/pistachio_implementation~ai-search-visibility-tracker/runs": { "post": { "operationId": "runs-sync-pistachio_implementation-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/pistachio_implementation~ai-search-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-pistachio_implementation-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", "type": "array", "description": "Questions your buyers might ask an AI assistant, one per line. Each prompt is sent to every selected engine.", "default": [ "What are the best project management tools for small teams?" ], "items": { "type": "string" } }, "brandName": { "title": "Brand name", "type": "string", "description": "The brand to look for in the answers.", "default": "Trello" }, "brandDomain": { "title": "Brand domain", "type": "string", "description": "Your website domain, for example example.com. Used to detect when an engine cites your site as a source. Subdomains count.", "default": "trello.com" }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other names that should count as a mention, such as product names or old names.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names to track in the same answers. A domain in brackets is optional and enables citation tracking, for example: Asana (asana.com).", "default": [ "Asana (asana.com)", "monday.com (monday.com)", "ClickUp (clickup.com)", "Notion (notion.so)" ], "items": { "type": "string" } }, "engines": { "title": "Engines", "type": "array", "description": "Which AI engines to query. An engine runs only if you supply its API key below.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini" ], "enumTitles": [ "ChatGPT (OpenAI API with web search)", "Perplexity (Sonar API)", "Gemini (Google Search grounding)" ] }, "default": [ "openai", "perplexity", "gemini" ] }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Your own OpenAI API key. Stored encrypted by Apify and never logged or saved to the output. OpenAI bills you directly for tokens and web search calls." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Your own Perplexity API key. Perplexity bills you directly." }, "geminiApiKey": { "title": "Google Gemini API key", "type": "string", "description": "Your own Gemini API key from Google AI Studio. Google bills you directly (a free tier exists for some models)." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Any OpenAI model that supports the web search tool in the Responses API.", "default": "gpt-4.1-mini" }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "Perplexity Sonar model, for example sonar or sonar-pro.", "default": "sonar" }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Gemini model that supports Google Search grounding.", "default": "gemini-2.5-flash" }, "country": { "title": "Country code", "type": "string", "description": "Optional two letter country code (for example US or GB) passed to engines that support approximate user location for search." }, "includeAnswerText": { "title": "Include full answer text", "type": "boolean", "description": "Save the full answer from each engine in the output.", "default": true }, "demoMode": { "title": "Demo mode", "type": "boolean", "description": "Analyze bundled sample answers instead of calling any engine. Free, no keys needed. Also used automatically when no key is supplied.", "default": false } } }, "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 } } } } } } } } } }