{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Tracker (ChatGPT, Perplexity, Claude)", "description": "Ask ChatGPT, Perplexity and Claude the questions your customers ask, and measure whether your brand is mentioned, how high it ranks against competitors, and whether your site is cited.", "version": "0.1", "x-build-id": "1zfLFUaVcNL1sXoHL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devotee~ai-brand-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devotee-ai-brand-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/devotee~ai-brand-visibility-tracker/runs": { "post": { "operationId": "runs-sync-devotee-ai-brand-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/devotee~ai-brand-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-devotee-ai-brand-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", "prompts" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand to look for in AI answers." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other names the brand goes by (product names, abbreviations). Matching is case-insensitive and whole-word.", "items": { "type": "string" } }, "brandDomains": { "title": "Brand domains", "type": "array", "description": "Your websites. A citation pointing to one of these (or a subdomain) counts as the brand being cited.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "One per line. Optionally add aliases and domains separated by |, e.g. \"Confluence | Atlassian Confluence | atlassian.com\".", "items": { "type": "string" } }, "prompts": { "title": "Prompts", "maxItems": 50, "type": "array", "description": "Questions your customers might ask an AI assistant (up to 50 per run). Each prompt is sent unchanged to every selected engine, with web search on. Don't name your brand in the prompt unless you want to test branded queries.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Which assistants to ask. Each prompt × engine is one billed check.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "claude" ], "enumTitles": [ "ChatGPT (OpenAI)", "Perplexity", "Claude (Anthropic)" ] }, "default": [ "chatgpt", "perplexity", "claude" ] }, "country": { "title": "Country", "type": "string", "description": "Optional two-letter country code (e.g. US, GB, DE) to localize web search where the engine supports it (ChatGPT, Claude)." }, "includeAnswerText": { "title": "Include full answer text", "type": "boolean", "description": "Store each engine's full answer in the dataset.", "default": true }, "models": { "title": "Model overrides", "type": "object", "description": "Advanced, own API keys only: override the model per engine, e.g. {\"chatgpt\": \"gpt-5.5\"}. Ignored for engines that use the built-in keys." }, "maxConcurrency": { "title": "Max concurrent checks", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many checks run at the same time.", "default": 4 }, "openaiApiKey": { "title": "Your OpenAI API key (optional)", "type": "string", "description": "Use your own key: ChatGPT checks then bill at the lower own-key price and API usage goes to your OpenAI account." }, "perplexityApiKey": { "title": "Your Perplexity API key (optional)", "type": "string", "description": "Use your own Perplexity key." }, "anthropicApiKey": { "title": "Your Anthropic API key (optional)", "type": "string", "description": "Use your own Anthropic key." } } }, "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 } } } } } } } } } }