{
"openapi": "3.0.1",
"info": {
"title": "AI Search Visibility Tracker - ChatGPT, Perplexity, Gemini (EU)",
"description": "Track if ChatGPT, Perplexity & Gemini mention, rank and cite your brand. Native Dutch, German, French, Spanish, Italian & Polish prompts. Your own API keys.",
"version": "0.1",
"x-build-id": "z1KP2qWI4l9dbNqxx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/prevailing_glow~ai-search-visibility-tracker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-prevailing_glow-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/prevailing_glow~ai-search-visibility-tracker/runs": {
"post": {
"operationId": "runs-sync-prevailing_glow-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/prevailing_glow~ai-search-visibility-tracker/run-sync": {
"post": {
"operationId": "run-sync-prevailing_glow-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": [
"brandName"
],
"properties": {
"brandName": {
"title": "Brand name",
"type": "string",
"description": "The brand you want to track, e.g. Coolblue. Short all-caps names (2-4 letters, e.g. ING, KPN) are matched case-sensitively."
},
"brandAliases": {
"title": "Brand aliases",
"type": "array",
"description": "Other names the AI might use: product names, old names, spelling variants (e.g. Cool Blue). Avoid generic words: every alias counts as a brand mention.",
"items": {
"type": "string"
}
},
"brandDomains": {
"title": "Brand domains",
"type": "array",
"description": "Your website domain(s), e.g. coolblue.nl. Used to detect whether the AI cites your site as a source (subdomains count) and as extra mention aliases.",
"items": {
"type": "string"
}
},
"competitors": {
"title": "Competitors",
"type": "array",
"description": "One competitor per line: Name, alias, domain (comma or | separated), e.g. MediaMarkt, Media Markt, mediamarkt.nl. Used for share of voice, ranking and competitor citations. Max 25.",
"items": {
"type": "string"
}
},
"language": {
"title": "Language",
"enum": [
"nl",
"de",
"fr",
"es",
"it",
"pl",
"pt",
"en"
],
"type": "string",
"description": "Language of the generated prompts, the locale hint and the mention/sentiment matching. Custom prompts should be written in this language.",
"default": "en"
},
"country": {
"title": "Country",
"enum": [
"NL",
"BE",
"LU",
"DE",
"AT",
"CH",
"FR",
"ES",
"IT",
"PL",
"PT",
"IE",
"GB",
"US",
"DK",
"SE"
],
"type": "string",
"description": "Market to simulate: sent as the user's approximate location to ChatGPT web search and Perplexity, and mentioned in the locale hint. Default: the main country of the language (nl → Netherlands, de → Germany, ...). Use e.g. Dutch + Belgium for Flanders."
},
"prompts": {
"title": "Custom prompts",
"type": "array",
"description": "Questions to ask the AI engines, exactly as a customer would type them (max 200). If set, category/keywords are ignored. Leave empty to auto-generate prompts.",
"items": {
"type": "string"
}
},
"category": {
"title": "Category (for generated prompts)",
"type": "string",
"description": "Your product/service category as a plural noun phrase in the chosen language, e.g. nl webwinkels voor elektronica, de Online-Shops für Elektronik, fr boutiques d'électronique en ligne."
},
"keywords": {
"title": "Keywords / topics (for generated prompts)",
"type": "array",
"description": "Topics or needs, in the chosen language, e.g. een nieuwe wasmachine, een gaming laptop. Each keyword adds prompts like \"Wat zijn de beste opties voor {keyword} in Nederland?\".",
"items": {
"type": "string"
}
},
"maxGeneratedPrompts": {
"title": "Number of generated prompts",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "How many prompts to generate from category/keywords/competitors.",
"default": 5
},
"includeBrandPrompts": {
"title": "Include branded prompts",
"type": "boolean",
"description": "Also generate prompts that name your brand (\"What do you think of {brand}?\", \"{brand} or {competitor}?\"). Useful for sentiment; these always mention the brand, so they are excluded from discovery-style tracking by default.",
"default": false
},
"localeHint": {
"title": "Send locale hint",
"type": "boolean",
"description": "Tell ChatGPT and Gemini (via system instructions) where the user is and to answer in the chosen language, e.g. \"De gebruiker bevindt zich in Nederland. Antwoord in het Nederlands.\" Perplexity gets language_preference and location parameters instead.",
"default": true
},
"engines": {
"title": "Engines",
"type": "array",
"description": "Which AI engines to ask. Each prompt is sent to each selected engine (one check each). Gemini is tested against the live API. ChatGPT and Perplexity are beta: built from the official API docs but not yet tested against the live APIs.",
"items": {
"type": "string",
"enum": [
"chatgpt",
"perplexity",
"gemini"
],
"enumTitles": [
"ChatGPT (OpenAI Responses API + web search) - beta, not yet tested against live API",
"Perplexity (Agent API, web search) - beta, not yet tested against live API",
"Gemini (Gemini API, model knowledge, no web search)"
]
},
"default": [
"chatgpt",
"perplexity",
"gemini"
]
},
"openaiApiKey": {
"title": "OpenAI API key",
"type": "string",
"description": "Your key from platform.openai.com/api-keys (starts with sk-). Needed for ChatGPT checks (beta, not yet tested against the live API)."
},
"perplexityApiKey": {
"title": "Perplexity API key",
"type": "string",
"description": "Your key from the Perplexity API portal (starts with pplx-). Needed for Perplexity checks (beta, not yet tested against the live API)."
},
"geminiApiKey": {
"title": "Gemini API key",
"type": "string",
"description": "Your key from Google AI Studio (starts with AIza or AQ.). Needed for Gemini checks. A free-tier key works within Google's free limits (note: on the free tier Google may use prompts and answers to improve its products)."
},
"runsPerPrompt": {
"title": "Runs per prompt",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "AI answers vary between calls. Ask each prompt several times per engine to measure how often the brand appears (each run is a separate check).",
"default": 1
},
"openaiModel": {
"title": "OpenAI model",
"type": "string",
"description": "ChatGPT is beta (not yet tested against the live API). Any OpenAI model that supports the Responses API web search tool, e.g. gpt-6-luna (cheapest), gpt-6.1-sol (closer to ChatGPT's own answers).",
"default": "gpt-6-luna"
},
"openaiWebSearch": {
"title": "ChatGPT: use web search",
"type": "boolean",
"description": "Give the model OpenAI's web_search tool (it decides when to search, like ChatGPT). Required for cited URLs. OpenAI bills web search calls per call on your key.",
"default": true
},
"openaiSearchContextSize": {
"title": "ChatGPT: search context size",
"enum": [
"low",
"medium",
"high"
],
"type": "string",
"description": "How much web content OpenAI retrieves per search.",
"default": "medium"
},
"perplexityPreset": {
"title": "Perplexity preset",
"enum": [
"fast",
"low",
"medium",
"high"
],
"type": "string",
"description": "Perplexity is beta (not yet tested against the live API). Agent API preset. Default fast, or none when a model is set below."
},
"perplexityModel": {
"title": "Perplexity model (optional)",
"type": "string",
"description": "Optional Agent API model override, e.g. perplexity/sonar. Leave empty to use the preset's model."
},
"geminiModel": {
"title": "Gemini model",
"type": "string",
"description": "Gemini model ID. Default gemini-3.5-flash (works on the free tier). Alternatives: gemini-3.8-flash (newest; cheaper on paid keys until 31 Dec 2026, but often busy on the free tier), gemini-3.1-flash-lite (cheapest). Gemini runs without Google Search grounding, so its answers reflect the model's own knowledge, not live search, and contain no cited URLs.",
"default": "gemini-3.5-flash"
},
"geminiFallbackModel": {
"title": "Gemini fallback model",
"type": "string",
"description": "Used only when the Gemini model above still answers HTTP 503 \"high demand\" after all retries (after two such checks in a row it is tried first for the rest of the run). Default gemini-3.5-flash-lite (works on the free tier). Each row's model field shows the model that actually answered. Enter none to disable the fallback.",
"default": "gemini-3.5-flash-lite"
},
"geminiEndpoint": {
"title": "Gemini API endpoint",
"enum": [
"generateContent",
"interactions"
],
"type": "string",
"description": "Which Gemini API endpoint to call. generateContent is Google's stable endpoint; the Interactions API is marked beta by Google. Both were tested against the live API.",
"default": "generateContent"
},
"maxOutputTokens": {
"title": "Max output tokens",
"minimum": 256,
"maximum": 32000,
"type": "integer",
"description": "Optional cap on answer length per call (reduces cost on your key). Leave empty for the provider default; note that reasoning models count reasoning tokens toward this limit."
},
"maxChecks": {
"title": "Max checks per run",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Safety cap on prompt × engine × run checks (protects your API budget and the run cost). The run's Maximum cost per run setting is also respected: no AI call is started that the remaining budget could not pay for.",
"default": 200
},
"maxConcurrency": {
"title": "Max concurrency (total)",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many API calls run in parallel overall.",
"default": 4
},
"maxConcurrencyPerEngine": {
"title": "Max concurrency per engine",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Parallel calls per provider. Lower it if your API tier has low rate limits; HTTP 429 responses are retried with backoff and pause that engine.",
"default": 2
},
"requestTimeoutSecs": {
"title": "Request timeout",
"minimum": 10,
"maximum": 600,
"type": "integer",
"description": "Timeout per API call (web search answers can take 10-60 s).",
"default": 120
},
"maxRetries": {
"title": "Max retries",
"minimum": 0,
"maximum": 8,
"type": "integer",
"description": "Retries for timeouts, network errors, HTTP 429 and 5xx, with exponential backoff + jitter and Retry-After support. Gemini waits longer (5 s doubling up to 60 s per wait, and Google's \"retry in N s\" hints of up to 90 s), because its 503 \"high demand\" spells and free-tier limits need time to clear. Invalid keys, exhausted credits and a reached daily free-tier quota are not retried further: that engine is stopped with a clear error.",
"default": 3
},
"historyStoreName": {
"title": "History store name (optional)",
"type": "string",
"description": "Name of a key-value store to keep results between runs (e.g. ai-visibility-coolblue). Each run is compared with the previous one: deltas in mention rate, share of voice and visibility score, plus prompts where the brand newly appeared or disappeared. Ideal with a weekly Schedule."
},
"includeAnswerText": {
"title": "Include full answer text",
"type": "boolean",
"description": "Store the full AI answer in each row. Turn off for smaller datasets.",
"default": true
},
"dryRun": {
"title": "Dry run (no API calls)",
"type": "boolean",
"description": "Only build and list the planned prompt × engine checks; nothing is sent to the AI providers and nothing is charged.",
"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
}
}
}
}
}
}
}
}
}
}