{ "openapi": "3.0.1", "info": { "title": "AI Visibility Tracker: Share of Voice in ChatGPT & Claude", "description": "Brand, competitors and prompts in (your own LLM keys); mentions, rank, citations and share of voice per AI engine out. From $0.01 per answer.", "version": "1.0", "x-build-id": "tUbfs56pUEtKTsdvN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apricot_blackberry~ai-answer-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apricot_blackberry-ai-answer-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/apricot_blackberry~ai-answer-visibility-tracker/runs": { "post": { "operationId": "runs-sync-apricot_blackberry-ai-answer-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/apricot_blackberry~ai-answer-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-apricot_blackberry-ai-answer-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": [ "brand" ], "properties": { "brand": { "title": "Brand", "type": "string", "description": "The brand to track in ChatGPT, Claude, Gemini and Perplexity answers, written the way people write it. Also replaces {brand} in prompts. The only required field. Example: Notion" }, "brandAliases": { "title": "Brand aliases", "maxItems": 25, "type": "array", "description": "Other spellings or names for your brand, one per line, up to 25. Matching is case-insensitive on whole words, so add every variant you care about. Example: Notion AI", "default": [], "items": { "type": "string" } }, "brandDomain": { "title": "Brand domain", "type": "string", "description": "Your website domain without https://. When set, every answer reports brandCited and the report adds citationRate (share of answers that cite your site). Leave empty to skip citation checks. Example: notion.so", "default": "" }, "competitors": { "title": "Competitors", "maxItems": 25, "type": "array", "description": "Competitors to compare share of voice against, one per line, up to 25. Add aliases with Name|alias1|alias2. Example: Coda|Coda.io", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Prompts", "maxItems": 200, "type": "array", "description": "Questions to ask each AI engine, one per line, up to 200 (each up to 2,000 characters). {brand} is replaced by your brand. Defaults to three built-in templates. Example: What are the best alternatives to {brand}?", "default": [ "What are the best alternatives to {brand}?", "Is {brand} worth it in 2026?", "What are the top tools like {brand}?" ], "items": { "type": "string" } }, "engines": { "title": "Engines", "type": "array", "description": "Which AI engines to ask: openai (ChatGPT), anthropic (Claude), gemini (Google Gemini), perplexity. An engine without an API key is skipped with one skipped row and no charge. Default: all four. Example: [\"openai\",\"perplexity\"]", "items": { "type": "string", "enum": [ "openai", "anthropic", "gemini", "perplexity" ], "enumTitles": [ "ChatGPT (OpenAI)", "Claude (Anthropic)", "Gemini (Google)", "Perplexity" ] }, "default": [ "openai", "anthropic", "gemini", "perplexity" ] }, "samplesPerPrompt": { "title": "Samples per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many times to ask each prompt on each engine, an integer from 1 to 5. AI answers vary from run to run, so 3 samples give a steadier share of voice. Example: 3", "default": 1 }, "models": { "title": "Models", "type": "object", "description": "Optional JSON object with a model override per engine (keys openai, anthropic, gemini, perplexity). Leave {} for the defaults: gpt-5-mini, claude-sonnet-4-5, gemini-3-flash, sonar. Example: {\"openai\":\"gpt-5-mini\",\"perplexity\":\"sonar\"}", "default": {} }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Your OpenAI API key for ChatGPT answers with web search (starts with sk-). Used only for this run, never logged or stored; your OpenAI account pays the provider cost. Leave empty to skip ChatGPT. Example: sk-proj-..." }, "anthropicApiKey": { "title": "Anthropic API key", "type": "string", "description": "Your Anthropic API key for Claude answers (starts with sk-ant-). Used only for this run, never logged or stored; your Anthropic account pays the provider cost. Leave empty to skip Claude. Example: sk-ant-..." }, "geminiApiKey": { "title": "Gemini API key", "type": "string", "description": "Your Google AI Studio API key for Gemini answers (starts with AIza). Used only for this run, never logged or stored. Leave empty to skip Gemini. Example: AIza..." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Your Perplexity API key (starts with pplx-). Used only for this run, never logged or stored. Leave empty to skip Perplexity. Example: pplx-..." }, "demoMode": { "title": "Demo mode", "type": "boolean", "description": "Replay bundled sample answers (2 prompts x your engines, about Notion) with no keys, no network calls and no charges. Rows are marked demo: true. Turn it on to see the output format before adding keys.", "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 } } } } } } } } } }