{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Tracker: ChatGPT, Perplexity & Gemini", "description": "AI brand monitoring across ChatGPT, Perplexity, Gemini and Google AI Overviews. Samples every prompt multiple times for mention rate, share of voice and week-over-week deltas — not a single-shot guess.", "version": "0.4", "x-build-id": "YLitiNYDeQdFfxqTz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/emoubarak~ai-search-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-emoubarak-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/emoubarak~ai-search-visibility-tracker/runs": { "post": { "operationId": "runs-sync-emoubarak-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/emoubarak~ai-search-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-emoubarak-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": [ "brand" ], "properties": { "brand": { "title": "Brand", "type": "string", "description": "The brand you want to track. Write it exactly as it appears in the market, e.g. \"Notion\", not \"notion.so\"." }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor brands to measure share of voice against. Brands the answers mention that are not on this list are still counted, they are just not guaranteed a row in the report.", "default": [], "items": { "type": "string" } }, "industry": { "title": "Industry / category", "type": "string", "description": "The category buyers would search in, e.g. \"project management software\". Used to generate the prompt set. Leave empty to let the model infer it from the brand name.", "default": "" }, "language": { "title": "Language", "type": "string", "description": "Language the prompts are written in, e.g. \"en\", \"fr\", \"de\". The answer engines respond in the language of the prompt.", "default": "en" }, "market": { "title": "Market (country code)", "type": "string", "description": "Two-letter country code, e.g. \"US\", \"FR\". Used to label the results and to phrase location-sensitive prompts. Note: the underlying answer engines do not expose a geo-targeting parameter, so this steers the prompts rather than the engine's own location.", "default": "US" }, "queries": { "title": "Custom prompts (optional)", "type": "array", "description": "Supply your own prompts to skip generation entirely. When set, these are used verbatim and no prompt-generation LLM call is made.", "default": [], "items": { "type": "string" } }, "maxPrompts": { "title": "Number of prompts", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many prompts to generate. They are stratified across commercial, informational, transactional, brand-defensive and competitor-comparison intents.", "default": 10 }, "samplesPerPrompt": { "title": "Samples per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many times each prompt is asked per engine. AI answers are non-deterministic, so 1 sample is a coin flip, not a measurement. 3 is the useful minimum; raise it to 5 when you need to detect small week-over-week changes.", "default": 3 }, "engines": { "title": "Answer engines", "type": "array", "description": "Which AI answer engines to query. Google AI Overviews does not render for every query — that is measured and reported as the answer trigger rate rather than hidden. Only Google AI Overviews can be localized to a market.", "items": { "type": "string", "enum": [ "perplexity", "google_aio", "chatgpt_search", "gemini" ], "enumTitles": [ "Perplexity", "Google AI Overviews", "ChatGPT Search", "Gemini" ] }, "default": [ "perplexity", "google_aio", "chatgpt_search", "gemini" ] }, "analysisMode": { "title": "Analysis mode", "enum": [ "full", "collect-only" ], "type": "string", "description": "\"Full\" scores every answer: brand mention, position, sentiment, competitors and which brand the answer recommends. \"Collect only\" stops after collection and returns the raw answers and citations with no analysis — cheaper, and the right choice if you run your own scoring.", "default": "full" }, "openRouterApiKey": { "title": "Your OpenRouter API key (optional)", "type": "string", "description": "Optional. Analysis runs on an included key by default, so you do not need an OpenRouter account. Supply your own key to use any model and to be billed a lower per-analysis rate — you then pay OpenRouter directly. Falls back to the OPENROUTER_API_KEY environment variable. Ignored in collect-only mode." }, "analysisModel": { "title": "Analysis model", "type": "string", "description": "Any OpenRouter model ID when you supply your own key. On the included key the choice is limited to openai/gpt-5.6-luna (default) and deepseek/deepseek-v4-flash-0731; anything else falls back to the default with a warning.", "default": "openai/gpt-5.6-luna" }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "If set, the full run summary — metrics, coverage and week-over-week deltas — is POSTed here as JSON when the run finishes. Useful for pushing results straight into a dashboard, Slack relay or data warehouse. Delivery is retried twice; a failing webhook never fails the run, and it costs nothing extra.", "default": "" } } }, "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 } } }, "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 } } } } } } } } } }