{ "openapi": "3.0.1", "info": { "title": "AI Citation Monitor — Which Sources AI Engines Cite", "description": "Track which sources and domains ChatGPT, Perplexity, Claude, and Gemini cite for your prompts — whether your domain is cited, who dominates the citation share, and how it changes over time. The GEO companion to rank tracking.", "version": "1.0", "x-build-id": "FGq5ufsQMc392whby" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~ai-citation-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-ai-citation-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/muhammadafzal~ai-citation-monitor/runs": { "post": { "operationId": "runs-sync-muhammadafzal-ai-citation-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/muhammadafzal~ai-citation-monitor/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-ai-citation-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", "properties": { "brandDomain": { "title": "Your Domain", "type": "string", "description": "The domain you want to see cited by AI engines (e.g., 'notion.so'). Each answer's cited sources are checked for this domain.", "default": "notion.so" }, "competitorDomains": { "title": "Competitor Domains", "type": "array", "description": "Competitor domains to also track in the citations (e.g., 'evernote.com', 'obsidian.md'). Lets you compare citation presence against rivals.", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Tracked Prompts", "type": "array", "description": "The questions your buyers ask AI engines (e.g., 'What is the best note-taking app?'). The actor records which sources each engine cites for them. If empty, prompts are auto-generated from 'industry'.", "default": [], "items": { "type": "string" } }, "industry": { "title": "Industry / Category", "type": "string", "description": "Your category (e.g., 'productivity software'). Used ONLY to auto-generate prompts when you don't supply your own. Ignored if 'prompts' is provided.", "default": "productivity software" }, "trackingId": { "title": "Tracking ID", "type": "string", "description": "Optional stable identifier used to store and compare citation history across scheduled runs. Defaults to a slug of your domain. Use distinct IDs to track multiple sites separately.", "default": "" }, "maxPrompts": { "title": "Max Prompts", "minimum": 1, "maximum": 200, "type": "integer", "description": "Safety cap on how many prompts are checked per run (cost control). Extra prompts beyond this limit are ignored.", "default": 25 }, "platforms": { "title": "AI Platforms", "type": "array", "description": "Internal: which engines to query. Managed by the actor (all four) for predictable cost.", "items": { "type": "string" }, "default": [ "perplexity", "chatgpt", "claude", "gemini" ] }, "models": { "title": "Model Overrides", "type": "object", "description": "Internal: per-engine OpenRouter model slug overrides. Managed by the actor; not user-editable.", "default": {} }, "useWebSearch": { "title": "Use Web Search", "type": "boolean", "description": "Internal: live web search for citation grounding. Managed by the actor (on).", "default": true }, "webSearchResults": { "title": "Web Search Results", "minimum": 1, "maximum": 10, "type": "integer", "description": "Internal: web results per query. Managed by the actor.", "default": 3 } } }, "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 } } } } } } } } } }