{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Tracker: ChatGPT & Perplexity", "description": "Track how ChatGPT and Perplexity mention your brand. Get the AI answers with cited sources, brand rank, share of voice vs competitors and alerts when visibility drops. Cheaper than the official ChatGPT and Perplexity scrapers.", "version": "0.0", "x-build-id": "UmP4i6zWKViL0fFJ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scoutforge~ai-search-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scoutforge-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/scoutforge~ai-search-visibility-tracker/runs": { "post": { "operationId": "runs-sync-scoutforge-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/scoutforge~ai-search-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-scoutforge-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": [ "prompts" ], "properties": { "prompts": { "title": "Prompts", "type": "array", "description": "Questions to ask the AI engines (e.g. 'best CRM for small agencies').", "items": { "type": "string" } }, "brand": { "title": "Your brand (optional)", "type": "string", "description": "Brand name to track in the answers. Leave empty to only get raw answers." }, "domain": { "title": "Your domain (optional)", "type": "string", "description": "Your website domain, e.g. mybrand.com. Used to check if it appears in cited sources." }, "competitors": { "title": "Competitors (optional)", "type": "array", "description": "Competitor brand names to track in the answers, used to compute share of voice.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "AI engines to query. Supported values: perplexity, openai.", "default": [ "perplexity", "openai" ], "items": { "type": "string" } }, "projectName": { "title": "Project name", "type": "string", "description": "History is stored per project so runs can be compared over time.", "default": "default" }, "perplexityPreset": { "title": "Perplexity preset", "type": "string", "description": "Perplexity Agent API preset: fast, low, medium, high or xhigh. 'fast' is the cheapest.", "default": "fast" }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "OpenAI model used with the web search tool. Change it if the API rejects the model name.", "default": "gpt-4.1-mini" }, "webhookUrl": { "title": "Alert webhook URL (optional)", "type": "string", "description": "Receives a POST request when the mention rate drops (n8n, Slack, Zapier...)." }, "alertDropPoints": { "title": "Alert threshold (points)", "type": "integer", "description": "Send an alert when the mention rate drops by at least this many points versus the previous run.", "default": 10 }, "perplexityApiKey": { "title": "Perplexity API key (testing only)", "type": "string", "description": "Optional. Used only if the PERPLEXITY_API_KEY environment variable is not set." }, "openaiApiKey": { "title": "OpenAI API key (testing only)", "type": "string", "description": "Optional. Used only if the OPENAI_API_KEY environment variable is not set." } } }, "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 } } } } } } } } } }