{ "openapi": "3.0.1", "info": { "title": "AI Brand Monitor: GEO / AI Search Visibility Tracker", "description": "Track how your brand appears in AI answers: Gemini & Claude out of the box, ChatGPT & Perplexity on your own key. Mention rate, rank among every option AI names, discovered competitors, share of voice and cited sources, sampled for reliability. GEO / AEO data for SEO agencies and brands.", "version": "0.1", "x-build-id": "XPIwLWocbFrLUgG3M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/foxlabs~ai-brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-foxlabs-ai-brand-monitor", "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/foxlabs~ai-brand-monitor/runs": { "post": { "operationId": "runs-sync-foxlabs-ai-brand-monitor", "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/foxlabs~ai-brand-monitor/run-sync": { "post": { "operationId": "run-sync-foxlabs-ai-brand-monitor", "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", "category" ], "properties": { "brand": { "title": "Brand / company name", "type": "string", "description": "The brand you want to track in AI answers (e.g. \"Notion\"). A person's name may carry titles: \"Uzm. Dt. Ayşe Yılmaz\" is also found where an answer writes \"Ayşe Yılmaz\"." }, "category": { "title": "Category / market — MUST match your brand", "type": "string", "description": "⚠ CHANGE THIS to match YOUR brand — it drives the questions. Write the market as your customers ask about it, with a location for a local business: \"CRM software\", \"dental clinic in Leeds\", \"Eskişehir'de protez diş hekimi\". The questions add \"best\" themselves, so a leading \"best\" / \"en iyi\" is dropped. A mismatched category returns 0% visibility (the #1 cause of empty results)." }, "language": { "title": "Question language", "enum": [ "auto", "en", "tr" ], "type": "string", "description": "Language of the auto-generated questions. Auto picks Turkish when the category is written in Turkish, else English. Ignored when you supply your own prompts.", "default": "auto" }, "brandDomain": { "title": "Brand domain (optional, for citation rate)", "type": "string", "description": "Your brand's website domain (e.g. \"notion.so\"). If provided, we measure how often AI engines cite YOUR domain as a source — the citation-rate component of the Visibility Index." }, "competitors": { "title": "Competitors (optional)", "type": "array", "description": "Competitors you want to be sure are tracked. Optional: every answer is also read for the other businesses, products or professionals it names, and those are ranked and counted too (see discoveredCompetitors in the summary).", "items": { "type": "string" } }, "engines": { "title": "AI engines to query", "type": "array", "description": "Gemini and Claude run on our keys. ChatGPT and Perplexity run only on your own API key — add it in the Advanced section, otherwise they are skipped and listed in enginesSkipped.", "items": { "type": "string", "enum": [ "gemini", "anthropic", "openai", "perplexity" ], "enumTitles": [ "Gemini (Google)", "Claude (Anthropic)", "ChatGPT (OpenAI) — your own key", "Perplexity — your own key" ] } }, "maxPromptsPerEngine": { "title": "Prompts per engine", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many buyer-intent questions to ask each engine (10 built-in questions per language; up to 25 with your own prompts). More prompts = broader coverage, higher cost." }, "samplesPerPrompt": { "title": "Samples per prompt (reliability)", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers change every time you ask. We run each prompt this many times and report a mention RATE + stability — not a single noisy snapshot. 3 is recommended; higher = more statistically reliable, higher cost." }, "prompts": { "title": "Advanced — custom prompts (overrides auto)", "type": "array", "description": "POWER USERS ONLY. Exact prompts to send to every engine. If filled, this OVERRIDES the auto-generated prompts from Category. Use {brand} and {category} as placeholders if you like.", "items": { "type": "string" } }, "webhookUrl": { "title": "Advanced — webhook / alert URL (optional)", "type": "string", "description": "If set, we POST the summary scorecard (JSON) to this URL when the run finishes — wire it to Slack, Make, Zapier or n8n for AI-visibility alerts." }, "openaiApiKey": { "title": "Advanced — your OpenAI API key (needed for ChatGPT)", "type": "string", "description": "ChatGPT runs only on your own OpenAI key — we keep none. The queries run on your OpenAI account." }, "perplexityApiKey": { "title": "Advanced — your Perplexity API key (needed for Perplexity)", "type": "string", "description": "Perplexity runs only on your own Perplexity key — we keep none. The queries run on your Perplexity account." }, "anthropicApiKey": { "title": "Advanced — your Anthropic API key (optional)", "type": "string", "description": "Bring your own Anthropic key to run Claude on your own account. Leave empty to use ours." }, "geminiApiKey": { "title": "Advanced — your Google Gemini API key (optional)", "type": "string", "description": "Bring your own Google AI Studio (Gemini) key to run Gemini on your own account. Leave empty to use ours." } } }, "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 } } } } } } } } } }