{
"openapi": "3.0.1",
"info": {
"title": "AI Search Visibility Tracker: ChatGPT, Perplexity",
"description": "Track brand mentions, share of voice and cited URLs in ChatGPT, Perplexity, Gemini, Google AI Overviews, AI Mode and Claude. Per prompt x engine: full answer, mention rank, sentiment, citations, your domain cited or not. Monitoring mode flags gained/lost mentions. GEO/AEO rank tracker.",
"version": "1.0",
"x-build-id": "eh9hiGApPOVL5L3SA"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/adyg~ai-search-visibility-tracker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-adyg-ai-search-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/adyg~ai-search-visibility-tracker/runs": {
"post": {
"operationId": "runs-sync-adyg-ai-search-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/adyg~ai-search-visibility-tracker/run-sync": {
"post": {
"operationId": "run-sync-adyg-ai-search-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": [
"brands"
],
"properties": {
"brands": {
"title": "Your brand(s)",
"minItems": 1,
"type": "array",
"description": "Your brand name, one per line. Add spelling variants after a |, e.g. HubSpot | HubSpot CRM. A token that looks like a domain (hubspot.com) is used as your domain. Matching is case-insensitive and whole-word.",
"items": {
"type": "string"
}
},
"domains": {
"title": "Your domain(s)",
"type": "array",
"description": "Your website domain(s), e.g. hubspot.com. Used to check whether AI answers cite your site (subdomains count). Writing the domain in the answer text also counts as a mention.",
"items": {
"type": "string"
}
},
"competitors": {
"title": "Competitors (optional)",
"type": "array",
"description": "Competitor brands to compare with, one per line: Name | variant | domain.com. Used for share of voice, rank and citation comparisons.",
"items": {
"type": "string"
}
},
"prompts": {
"title": "Prompts (questions)",
"type": "array",
"description": "Questions your buyers ask AI assistants, one per line, e.g. What is the best CRM for a small business?. Max 500 characters each. Every prompt is checked on every selected engine (1 prompt x 3 engines = 3 checks). Leave empty if you use seed topics.",
"items": {
"type": "string"
}
},
"seedTopics": {
"title": "Seed topics (generate prompts)",
"type": "array",
"description": "Optional: product categories such as CRM software or running shoes for flat feet. The Actor generates buyer-intent questions (\"What is the best ...\", \"alternatives to \", ...) for each topic and checks them too.",
"items": {
"type": "string"
}
},
"promptsPerTopic": {
"title": "Prompts per seed topic",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many questions to generate per seed topic.",
"default": 3
},
"promptGeneration": {
"title": "Prompt generation",
"enum": [
"templates",
"ai"
],
"type": "string",
"description": "Templates: proven buyer-intent question patterns (stable from run to run, best for monitoring). AI-written: an AI model writes natural, varied buyer questions for each topic (at no extra charge; up to 20 topics).",
"default": "templates"
},
"engines": {
"title": "AI engines",
"type": "array",
"description": "Engines to check every prompt on. Each prompt x engine is one check. ChatGPT, Gemini, Google AI Overviews and Google AI Mode are the real consumer answers (localized); Perplexity and Claude come from their official models.",
"items": {
"type": "string",
"enum": [
"chatgpt",
"perplexity",
"gemini",
"google_ai_overview",
"google_ai_mode",
"claude"
],
"enumTitles": [
"ChatGPT (with web search)",
"Perplexity (Sonar)",
"Gemini",
"Google AI Overviews",
"Google AI Mode",
"Claude (Haiku, no web search)"
]
},
"default": [
"chatgpt",
"perplexity",
"google_ai_overview"
]
},
"country": {
"title": "Country",
"type": "string",
"description": "Where the questions are asked from: country name (Germany), 2-letter code (DE) or location code (2276). 190+ countries.",
"default": "United States"
},
"language": {
"title": "Language",
"type": "string",
"description": "Language name (German) or code (de). Write your prompts in this language.",
"default": "English"
},
"monitoringMode": {
"title": "Monitoring mode (compare with previous run)",
"type": "boolean",
"description": "Save results to a named key-value store and compare each prompt x engine with the previous run: flags gained/lost mentions, citations and rank changes, and adds share-of-voice changes to the summary. Schedule the Actor (e.g. weekly) to track AI visibility over time.",
"default": false
},
"trackingId": {
"title": "Tracking ID",
"type": "string",
"description": "Name of this tracking project, e.g. hubspot-us. Runs with the same ID are compared with each other. Default: derived from your brand, country and language."
},
"monitoringStoreName": {
"title": "Monitoring store name",
"type": "string",
"description": "Named key-value store (in your Apify account) that keeps the previous results.",
"default": "ai-visibility-monitor"
},
"maxChecks": {
"title": "Max checks per run",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Upper limit of prompt x engine checks per run (cost control). The run also stops cleanly at your Maximum cost per run.",
"default": 200
},
"chatgptWebSearch": {
"title": "Force ChatGPT web search",
"type": "boolean",
"description": "Ask ChatGPT to search the web (like ChatGPT Search) so answers cite sources. Turn off to see what ChatGPT says from memory.",
"default": true
},
"includeAnswerText": {
"title": "Include full answer text",
"type": "boolean",
"description": "Save the complete AI answer (markdown) in each row.",
"default": true
},
"caseSensitive": {
"title": "Case-sensitive brand matching",
"type": "boolean",
"description": "Turn on for brand names that are also common words (e.g. Notion, Monday) to count only capitalized mentions.",
"default": false
},
"maxConcurrency": {
"title": "Max parallel checks",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many checks run at the same time.",
"default": 5
}
}
},
"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
}
}
}
}
}
}
}
}
}
}