{ "openapi": "3.0.1", "info": { "title": "AI GEO Recommendation Tracker — Audits & Reports", "description": "Audit AI visibility across ChatGPT, Claude, Gemini, and Perplexity. Get prioritized GEO recommendations, content gaps, trends, and HTML reports.", "version": "1.0", "x-build-id": "UrdqdVwgkxouO4Zq0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~ai-geo-rec-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-ai-geo-rec-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/muhammadafzal~ai-geo-rec-tracker/runs": { "post": { "operationId": "runs-sync-muhammadafzal-ai-geo-rec-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/muhammadafzal~ai-geo-rec-tracker/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-ai-geo-rec-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": [ "brandName" ], "properties": { "brandName": { "title": "Brand Name", "type": "string", "description": "The brand, company, or product to track in AI answers (e.g., 'Notion', 'Tesla'). Used as the primary entity for mention detection, position ranking, share-of-voice computation, and recommendation generation.", "default": "Notion" }, "brandDomain": { "title": "Brand Domain", "type": "string", "description": "Your brand's website domain (e.g., 'notion.so'). Used to detect when AI engines cite your site as a source and to compare citation rates against competitor domains. Leave empty to skip domain-based citation matching.", "default": "notion.so" }, "industry": { "title": "Industry / Category", "type": "string", "description": "Your category (e.g., 'productivity software', 'electric vehicles'). Used to auto-generate a relevant prompt set when you do not supply your own prompts below. Also informs recommendation context for GEO improvement suggestions. Ignored if 'prompts' is provided.", "default": "productivity software" }, "prompts": { "title": "Tracked Prompts", "type": "array", "description": "The exact questions your target audience asks AI engines (e.g., 'What is the best note-taking app?'). Provide your own list for precise tracking. If left empty, prompts are auto-generated from 'industry'. Each prompt is checked on every selected platform. Higher prompt variety produces richer recommendations.", "items": { "type": "string" }, "default": [] }, "platforms": { "title": "AI Platforms to Track", "type": "array", "description": "AI answer engines to check: perplexity, chatgpt, claude, gemini (default for API calls: all four; the Console form starts with ChatGPT only for a quick low-cost check). Each engine runs a fixed model through OpenRouter, paid by the Actor owner: perplexity → perplexity/sonar, chatgpt → openai/gpt-6-luna, claude → anthropic/claude-haiku-5.5, gemini → google/gemini-3.5-flash-lite. Each prompt is checked on every selected engine and each successful check is one charged event.", "items": { "type": "string", "enum": [ "perplexity", "chatgpt", "claude", "gemini" ], "enumTitles": [ "Perplexity", "ChatGPT", "Claude", "Gemini" ] }, "default": [ "perplexity", "chatgpt", "claude", "gemini" ] }, "competitorBrands": { "title": "Competitor Brands", "type": "array", "description": "Competitor brand names to track alongside yours (e.g., 'Evernote', 'Obsidian', 'Coda'). Used to compute your position ranking, share-of-voice, and to identify which competitors are outperforming you in AI visibility. The more competitors listed, the richer the comparison insights and recommendations.", "items": { "type": "string" }, "default": [] }, "competitorDomains": { "title": "Competitor Domains", "type": "array", "description": "Competitor website domains for citation comparison (e.g., 'evernote.com', 'obsidian.md'). Used to detect when AI engines cite competitor sites but not yours — a key signal for GEO recommendations. Leave empty if you do not need domain-level citation gap analysis.", "items": { "type": "string" }, "default": [] }, "generateHtmlReport": { "title": "Generate HTML Report", "type": "boolean", "description": "When enabled, produces an agency-ready HTML report in the key-value store under REPORT. The report includes visibility score cards, per-platform breakdowns, position trends (if history exists), citation analysis, and top prioritized recommendations. Disable for MCP/API-only consumption to save runtime.", "default": true }, "trackingId": { "title": "Tracking ID", "type": "string", "description": "Optional stable identifier used to store and compare history across scheduled runs. Defaults to a slug of the brand name. Use different IDs to track multiple brands independently. The history enables trend-based recommendations (e.g., 'visibility has dropped 3 weeks in a row — take action now').", "default": "" }, "useWebSearch": { "title": "Use Web Search", "type": "boolean", "description": "Ground ChatGPT, Claude, and Gemini answers with live web results (OpenRouter web plugin, Exa engine). Perplexity Sonar always searches natively. Keep on for current AI-search visibility; turn off to test the models' built-in knowledge only. Web search cost is included in the event price.", "default": true }, "webSearchResults": { "title": "Web Search Results", "minimum": 1, "maximum": 3, "type": "integer", "description": "Web results per check for ChatGPT, Claude, and Gemini when web search is on (1-3). Capped at 3 per request; higher values sent through the API are reduced to 3.", "default": 3 }, "maxPrompts": { "title": "Max Prompts", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of prompts checked per run (1-200). Prompts beyond this cap are skipped. Total checks = prompts × selected engines, and each successful check is charged once. Hosted free-plan runs are limited to 1 result from 1 OpenRouter request.", "default": 25 } } }, "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 } } } } } } } } } }