{ "openapi": "3.0.1", "info": { "title": "AI Visibility Tracker: ChatGPT, Perplexity, Gemini & Google", "description": "Does AI recommend your brand? Ask ChatGPT, Perplexity, Gemini, Copilot, Google AI Mode and AI Overviews your customers' questions and get brand mentions, rank vs competitors, citations, share of voice, gap questions and the sources AI cites.", "version": "1.0", "x-build-id": "5YjL5DXDMMjLOkiJG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~ai-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-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/ksvan~ai-visibility-tracker/runs": { "post": { "operationId": "runs-sync-ksvan-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/ksvan~ai-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-ksvan-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" ], "properties": { "brand": { "title": "Your brand", "type": "string", "description": "Brand, product or company name exactly as people write it, e.g. 'Zoho Projects'." }, "brandDomain": { "title": "Your website domain", "type": "string", "description": "Used to detect when AI engines cite your site as a source, e.g. 'zoho.com'. Mentions of the domain in the answer count as brand mentions too." }, "brandAliases": { "title": "Other names of your brand", "type": "array", "description": "Spellings, short names or product names that should count as your brand.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "One per line: 'Name', 'Name | domain.com' or 'Name | domain.com | alias1, alias2'. Up to 15. Used for rank, share of voice, the leaderboard and gap questions.", "items": { "type": "string" } }, "queries": { "title": "Questions people ask AI", "type": "array", "description": "Prompts your customers would type into ChatGPT or Google, one per line. Leave empty and fill in a category to generate them.", "items": { "type": "string" } }, "category": { "title": "Category (generates questions)", "type": "string", "description": "Optional, e.g. 'project management software'. Adds questions like 'best {category}', '{brand} alternatives', 'is {brand} worth it' and '{brand} vs {competitor}'." }, "autoQueries": { "title": "Generate questions from category and brand", "type": "boolean", "description": "When a category is set (or no questions are given), add generated questions to yours.", "default": true }, "maxQueries": { "title": "Max questions", "minimum": 1, "maximum": 200, "type": "integer", "description": "Upper limit on questions per run. Each question is asked on every selected engine.", "default": 25 }, "engines": { "title": "AI engines", "type": "array", "description": "Real answers from each engine's public web interface (what your customers see), collected by Apify's official scrapers.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "gemini", "copilot", "google_ai_mode", "google_ai_overview" ], "enumTitles": [ "ChatGPT (search)", "Perplexity", "Gemini", "Microsoft Copilot", "Google AI Mode", "Google AI Overview" ] }, "default": [ "chatgpt", "perplexity", "gemini", "google_ai_overview" ] }, "country": { "title": "Country", "enum": [ "us", "gb", "ca", "au", "de", "fr", "es", "it", "nl", "pl", "in", "br", "jp" ], "type": "string", "description": "Location the AI engines answer from (not used by Google AI Overview).", "default": "us" }, "includeFullAnswer": { "title": "Include full AI answer", "type": "boolean", "description": "Off keeps only the first 600 characters of each answer.", "default": true }, "allowFreePlanPrices": { "title": "Allow Free-plan engine prices", "type": "boolean", "description": "On the Apify Free plan, Apify charges $0.20 per answer for ChatGPT, Perplexity, Gemini, Copilot and AI Mode (from $0.005 on any paid plan), so these engines are skipped unless you turn this on. Google AI Overview always runs.", "default": false }, "maxParallelEngines": { "title": "Engines in parallel", "minimum": 1, "maximum": 6, "type": "integer", "description": "Each engine is a separate Actor run on your account. Keep it low on plans with few concurrent runs.", "default": 2 }, "engineTimeoutSecs": { "title": "Timeout per engine (seconds)", "minimum": 60, "maximum": 3600, "type": "integer", "description": "How long to wait for one engine to answer all questions.", "default": 900 }, "maxEngineCostUsd": { "title": "Max cost per engine (USD)", "minimum": 0, "type": "number", "description": "Optional cap on what one engine run may charge your account." } } }, "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 } } } } } } } } } }