{ "openapi": "3.0.1", "info": { "title": "AI Visibility Tracker: ChatGPT, Perplexity, Gemini", "description": "AI visibility tracker and LLM brand monitor: does ChatGPT, Perplexity, Gemini or Claude name your brand? Mentions, rank, cited sources and share of voice vs competitors, per engine. Charged per answer; failures are free.", "version": "0.1", "x-build-id": "RCF6OiaaHJWuqy0Xj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/meridianlabs~ai-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-meridianlabs-ai-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/meridianlabs~ai-visibility-tracker/runs": { "post": { "operationId": "runs-sync-meridianlabs-ai-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/meridianlabs~ai-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-meridianlabs-ai-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": "Your brand", "type": "string", "description": "Your brand name, then optionally its website and other names, separated by commas: 'HubSpot, hubspot.com, HubSpot CRM'. The website is used to spot when an answer cites you." }, "competitors": { "title": "Competitors", "type": "array", "description": "Up to 20, one per line, same format: 'Pipedrive, pipedrive.com'. Share of voice is worked out across your brand and these.", "items": { "type": "string" } }, "brandAliases": { "title": "Other names for your brand", "type": "array", "description": "Optional: product names or spellings that should count as your brand.", "default": [], "items": { "type": "string" } }, "brandDomains": { "title": "Your other websites", "type": "array", "description": "Optional: more domains of yours (subdomains are included automatically).", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Prompts", "type": "array", "description": "The questions your buyers ask AI assistants, one per line, up to 100 per run and 500 characters each, e.g. 'best CRM for a small agency'. Each prompt is asked once per engine (times samplesPerPrompt).", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Each engine is one charged answer per prompt. Default: all four.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "gemini", "claude" ], "enumTitles": [ "ChatGPT (the app's answer, with citations)", "Perplexity (Sonar, live web search)", "Gemini (the app's answer)", "Claude (model knowledge, no web search)" ] }, "default": [ "chatgpt", "perplexity", "gemini", "claude" ] }, "country": { "title": "Country", "type": "string", "description": "2-letter code the answers are asked from: US, GB (or UK), DE, AU, CA, IN... 191 countries. Claude ignores it (no web search).", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language code: en, de, fr, es, pt, it, nl, ja...", "default": "en" }, "samplesPerPrompt": { "title": "Repeats per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers change from one ask to the next. Ask each prompt 2-5 times per engine for steadier numbers (each repeat is a charged answer).", "default": 1 }, "includeAnswerText": { "title": "Include the answer text", "type": "boolean", "description": "Keep the full answer (markdown) in each row. Turn off for smaller exports.", "default": true }, "projectName": { "title": "Project name (compare with last run)", "type": "string", "description": "Optional. Give the same name on every run (e.g. 'Acme weekly') and the summary shows the change since the last run with that name. Kept in a store in your own Apify account ('ai-visibility-tracker-history'); delete it any time." }, "failOnErrors": { "title": "Fail the run if any answer fails", "type": "boolean", "description": "Off: failed answers are free error rows and the run succeeds. On: the run is marked failed (useful for schedules that alert).", "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 } } } } } } } } } }