{ "openapi": "3.0.1", "info": { "title": "AI Visibility & Share of Voice Tracker: ChatGPT, Perplexity", "description": "Track how ChatGPT and Perplexity answer your buyer prompts: brand mentions, rank in the answer, cited URLs and domains, sentiment, share of voice vs competitors and week-over-week changes. Official APIs with web search, no browser. By SteadyScrape.", "version": "0.1", "x-build-id": "0hvGQctMh7LnmJ9No" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steady-scrape~ai-brand-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steady-scrape-ai-brand-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/steady-scrape~ai-brand-visibility-tracker/runs": { "post": { "operationId": "runs-sync-steady-scrape-ai-brand-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/steady-scrape~ai-brand-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-steady-scrape-ai-brand-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": [ "prompts", "brands" ], "properties": { "prompts": { "title": "Prompts", "type": "array", "description": "Questions your buyers ask AI assistants, one per line. Each prompt is sent to every selected engine (one check per prompt x engine).", "items": { "type": "string" } }, "brands": { "title": "Your brands", "type": "array", "description": "Brands to track. Plain names or objects with optional aliases and domains, e.g. {\"name\": \"HubSpot\", \"aliases\": [\"HubSpot CRM\"], \"domains\": [\"hubspot.com\"]}. Domains are used to detect when the engine cites your site." }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor brands, same format as your brands. Used for rank and share of voice." }, "engines": { "title": "Engines", "type": "array", "description": "Which AI engines to ask. Each engine adds one check per prompt.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity" ], "enumTitles": [ "ChatGPT (OpenAI API with web search)", "Perplexity (Agent API with web search)" ] }, "default": [ "chatgpt", "perplexity" ] }, "country": { "title": "Country (optional)", "type": "string", "description": "Two-letter country code (US, GB, DE...) passed to web search as the approximate user location. Leave empty for no location. Applied on Perplexity and the direct OpenAI route; not sent on the OpenRouter route." }, "compareWithPrevious": { "title": "Compare with previous run", "type": "boolean", "description": "Save a snapshot in a named key-value store in your account and report changes since the last run with the same prompts, brands and engines (or the same tracking ID). Schedule the Actor weekly for week-over-week reports.", "default": true }, "trackingId": { "title": "Tracking ID (optional)", "type": "string", "description": "Name for this tracking set, e.g. \"acme-crm-weekly\". Keeps history linked even when you edit prompts or brands. Default: derived from prompts, brands and engines." }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Named key-value store (in your Apify account) that keeps the previous-run snapshots.", "default": "ai-brand-visibility-history" }, "openaiModel": { "title": "ChatGPT: OpenAI model", "enum": [ "gpt-6-luna", "gpt-5.6-luna" ], "type": "string", "description": "OpenAI model for the ChatGPT engine (as openai/ with native web search on OpenRouter, or with the Responses API web_search tool on the OpenAI API). API answers can differ from the ChatGPT app.", "default": "gpt-6-luna" }, "chatgptProvider": { "title": "ChatGPT provider route", "enum": [ "auto", "openrouter", "openai" ], "type": "string", "description": "How the ChatGPT engine is reached. auto = OpenRouter (OpenAI model with OpenAI's native web search) when the OPENROUTER_API_KEY secret is set, otherwise the OpenAI API directly.", "default": "auto" }, "openaiSearchContextSize": { "title": "ChatGPT: search context size", "enum": [ "low", "medium", "high" ], "type": "string", "description": "How much web search context the model gets (OpenAI search_context_size).", "default": "medium" }, "openaiMaxSearches": { "title": "ChatGPT: max web searches per check", "minimum": 1, "maximum": 3, "type": "integer", "description": "Upper bound on web search calls per answer (OpenAI max_tool_calls). Applies to the direct OpenAI API route; on OpenRouter the native search plugin decides.", "default": 2 }, "forceWebSearch": { "title": "ChatGPT: always search the web", "type": "boolean", "description": "On: the model must search before answering (tool_choice required), so answers carry citations. Off: the model decides. Direct OpenAI API route only; the OpenRouter web plugin always searches.", "default": true }, "perplexityEffort": { "title": "Perplexity: effort level", "enum": [ "fast", "low", "medium" ], "type": "string", "description": "Perplexity Agent API effort level (preset model, search and step settings).", "default": "low" }, "perplexityModel": { "title": "Perplexity: model override (optional)", "enum": [ "auto", "openai/gpt-6-luna", "openai/gpt-5.6-luna", "perplexity/sonar" ], "type": "string", "description": "Model override. auto uses the effort level's model.", "default": "auto" }, "includeFullAnswer": { "title": "Include full answer text", "type": "boolean", "description": "Off: only a 500-character snippet is stored per check.", "default": true }, "maxChecks": { "title": "Max checks per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper bound on prompt x engine checks in one run (hard cap 2,000).", "default": 200 }, "maxCostUsd": { "title": "Provider cost cap per run (USD)", "minimum": 0.01, "maximum": 100, "type": "number", "description": "Safety cap on estimated AI provider cost. New checks stop starting once the cap would be exceeded. Checks not run are not charged.", "default": 5 }, "maxOutputTokens": { "title": "Max answer tokens", "minimum": 300, "maximum": 4000, "type": "integer", "description": "Upper bound on answer length (OpenAI max_output_tokens).", "default": 2000 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 15, "maximum": 300, "type": "integer", "description": "Per request timeout.", "default": 120 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 4, "type": "integer", "description": "Retries for timeouts, rate limits (429) and provider 5xx errors, with backoff.", "default": 2 }, "concurrency": { "title": "Parallel checks", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many checks run at the same time.", "default": 4 }, "mockMode": { "title": "Mock mode (test data)", "type": "boolean", "description": "Return synthetic answers without calling any AI provider. Useful to preview the output format. Mock checks are never 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 } } } } } } } } } }