{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Tracker: ChatGPT, Perplexity, Gemini", "description": "Track how often ChatGPT, Perplexity, Gemini, Claude and Grok mention and cite your brand vs competitors. Share of voice, rank, citations, sentiment, gaps and week-over-week changes. No API keys needed.", "version": "1.0", "x-build-id": "Kz5TcN1fD7kQWgifO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/craplarp~ai-brand-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-craplarp-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/craplarp~ai-brand-visibility-tracker/runs": { "post": { "operationId": "runs-sync-craplarp-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/craplarp~ai-brand-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-craplarp-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" ], "properties": { "brand": { "title": "Your brand", "type": "string", "description": "The brand to track, exactly as people write it (e.g. Notion)." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names that count as a mention (e.g. Notion AI, notion.so).", "items": { "type": "string" } }, "brandDomains": { "title": "Brand domains", "type": "array", "description": "Your website domains. A citation (source link) to these counts as 'cited' (e.g. notion.so, notion.com).", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "One competitor per line. Optionally add aliases and domains after commas: 'Asana, asana.com' or 'Microsoft Loop, Loop, loop.cloud.microsoft'.", "items": { "type": "string" } }, "prompts": { "title": "Prompts (questions to ask the AIs)", "type": "array", "description": "Questions your buyers ask AI assistants. Don't name your brand — measure whether the AI brings it up by itself.", "items": { "type": "string" } }, "category": { "title": "Category (for auto-generated prompts)", "type": "string", "description": "Describe what you sell (e.g. 'project management software for small teams'). Used to generate extra buyer questions automatically." }, "autoGeneratePrompts": { "title": "Auto-generate extra prompts", "minimum": 0, "maximum": 30, "type": "integer", "description": "Number of additional realistic buyer questions to generate from the category (0 = off). Generation is free; each generated prompt is checked like the others.", "default": 0 }, "engines": { "title": "AI engines", "type": "array", "description": "Which AI assistants to ask. Each uses its own built-in web search.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "gemini", "claude", "grok" ], "enumTitles": [ "ChatGPT (OpenAI)", "Perplexity", "Gemini (Google)", "Claude (Anthropic)", "Grok (xAI)" ] }, "default": [ "chatgpt", "perplexity", "gemini", "claude" ] }, "samplesPerPrompt": { "title": "Samples per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers vary between runs. Asking the same question several times gives a reliable mention probability instead of a coin flip. Each sample is one check.", "default": 1 }, "userLocation": { "title": "User country", "type": "string", "description": "Optional. Ask as a user from this country (e.g. Poland, United States) — affects which brands and sources AIs prefer." }, "answerLanguage": { "title": "Answer language", "type": "string", "description": "Optional. Ask the AIs to answer in this language (e.g. German). Leave empty to use the prompt's language." }, "analyzeSentiment": { "title": "Analyze sentiment", "type": "boolean", "description": "For answers that mention your brand, classify how it is described (positive / neutral / negative) with a one-line reason. Free.", "default": true }, "compareWithPreviousRun": { "title": "Compare with previous run", "type": "boolean", "description": "Remember results and show changes since the last run with the same brand, prompts and engines. Ideal with a weekly schedule.", "default": true }, "openrouterApiKey": { "title": "Your OpenRouter API key (optional)", "type": "string", "description": "Optional. Bring your own OpenRouter key and pay the AI providers directly — checks are then charged at the much lower 'own key' price." }, "modelOverrides": { "title": "Model overrides", "type": "object", "description": "Optional. Map engine to an OpenRouter model ID, e.g. {\"chatgpt\": \"~openai/gpt-mini-latest\"}. Defaults use each vendor's current fast model." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel AI requests.", "default": 6 } } }, "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 } } } } } } } } } }