{ "openapi": "3.0.1", "info": { "title": "LLM Brand Visibility and Citation Tracker", "description": "Track how your brand appears in LLM answers (ChatGPT, Perplexity, Gemini, optional Claude): brand mentions & aliases, response rank/position, Share of Voice vs competitors, citation signals, sentiment, and a 0-100 visibility score. One run returns per-prompt evidence plus a structured summary.", "version": "1.0", "x-build-id": "CAwqqXe0hChO60q3M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~llm-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-llm-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/dltik~llm-visibility-tracker/runs": { "post": { "operationId": "runs-sync-dltik-llm-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/dltik~llm-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-dltik-llm-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 or product name (required)", "type": "string", "description": "The brand, product, company or tool name to track in LLM answers (e.g. 'Notion', 'Ahrefs')." }, "domain": { "title": "Brand website domain", "type": "string", "description": "Optional but recommended. The brand's primary domain (e.g. 'notion.so', 'ahrefs.com'). Used to detect citations of your site." }, "aliases": { "title": "Brand aliases (alternate names)", "type": "array", "description": "Optional. Other names the brand is known by (e.g. ['Notion HQ', 'Notion Labs']). Improves mention detection.", "items": { "type": "string" } }, "competitors": { "title": "Competitor brands to compare", "type": "array", "description": "Optional but high-value. Up to ~10 competitor brand names (e.g. ['Coda', 'ClickUp']). Enables Share of Voice and gap analysis.", "items": { "type": "string" } }, "category": { "title": "Product category or industry", "type": "string", "description": "Optional. The category the brand competes in (e.g. 'project management', 'web scraping'). Improves auto-generated prompts." }, "keywords": { "title": "Keywords/topics to monitor", "type": "array", "description": "Topics to test. Prompts are auto-generated per keyword (e.g. ['web scraping tool', 'data extraction API']). Provide this OR customPrompts.", "items": { "type": "string" } }, "customPrompts": { "title": "Custom prompts (real user questions)", "type": "array", "description": "Optional. Exact prompts to send to each LLM, phrased the way your customers ask. Sent as-is (no auto-generation). Provide this OR keywords.", "items": { "type": "string" } }, "mode": { "title": "Audit depth", "enum": [ "quick", "standard", "deep" ], "type": "string", "description": "Depth preset controlling prompts generated per keyword: 'quick' (3), 'standard' (5), 'deep' (10). More prompts = more thorough and more billable checks.", "default": "standard" }, "llms": { "title": "Which LLMs to query", "type": "array", "description": "The LLMs to query via OpenRouter. Defaults to GPT-4o-mini, Claude Haiku and Gemini Flash.", "items": { "type": "string" } }, "includePerplexity": { "title": "Include Perplexity", "type": "boolean", "description": "Also query Perplexity (adds a live-search engine with native citations) when a Perplexity key is configured.", "default": true }, "maxPrompts": { "title": "Max prompts (hard cap)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Optional override. Hard cap on the total number of unique prompts sent (across all keywords), before multiplying by the number of LLMs." }, "country": { "title": "Country", "type": "string", "description": "Two-letter country context for prompt generation (e.g. 'US', 'FR').", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language for prompts and answers (e.g. 'en', 'fr').", "default": "en" }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "Optional HTTPS URL that receives a POST with the full run summary when the run finishes. Useful for scheduled monitoring pipelines." }, "demoMode": { "title": "Health check / dry-run", "type": "boolean", "description": "When true, runs a connectivity check without calling any LLM and exits. Nothing is charged. Use it to validate your setup for free.", "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 } } }, "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 } } } } } } } } } }