{ "openapi": "3.0.1", "info": { "title": "AI Answer Brand Monitor: ChatGPT, Copilot, Google AI Overviews", "description": "See whether ChatGPT, Microsoft Copilot and Google AI Overviews mention your brand for the prompts your customers ask: list position, competitors named, cited sources and whether your domain is cited. Powered by cloro.", "version": "0.1", "x-build-id": "0vZIfsRy2gyhN639u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/appgild~ai-answer-brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-appgild-ai-answer-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/appgild~ai-answer-brand-monitor/runs": { "post": { "operationId": "runs-sync-appgild-ai-answer-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/appgild~ai-answer-brand-monitor/run-sync": { "post": { "operationId": "run-sync-appgild-ai-answer-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" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand to look for in each answer, as people write it (for example \"HubSpot\"). Matching ignores case and treats spaces and hyphens alike." }, "aliases": { "title": "Other names for the brand", "type": "array", "description": "Optional. Other names that count as a mention, such as a product name or a short form.", "default": [], "items": { "type": "string" } }, "domain": { "title": "Brand website domain", "type": "string", "description": "Optional. Your domain (for example hubspot.com). The output says whether each answer cites it, and a mention of the domain counts as a mention of the brand.", "default": "" }, "prompts": { "title": "Prompts", "type": "array", "description": "Questions your customers ask an AI assistant, one per line. Up to 200 per run (prompts and keywords together). Each prompt is checked on every engine you choose. Leave empty when you use keywords instead.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords (turned into prompts)", "type": "array", "description": "Optional. Search keywords; each becomes the question \"What are the best {keyword}? Name the top options.\"", "default": [], "items": { "type": "string" } }, "engines": { "title": "Engines", "type": "array", "description": "Which AI answers to check. ChatGPT and Copilot answers come from the live apps (via cloro); Google AI Overviews from Google search results (via DataForSEO). Each engine is one charged check per prompt.", "items": { "type": "string", "enum": [ "chatgpt", "copilot", "google_ai_overview" ], "enumTitles": [ "ChatGPT", "Microsoft Copilot", "Google AI Overview" ] }, "default": [ "chatgpt", "copilot", "google_ai_overview" ] }, "competitors": { "title": "Competitors to watch", "type": "array", "description": "Optional. Competitor names; the output lists which of them each answer mentions. Every name an answer lists is reported anyway.", "default": [], "items": { "type": "string" } }, "state": { "title": "US state for ChatGPT and Copilot", "type": "string", "description": "Optional two-letter US state code (for example TX). ChatGPT and Copilot are asked from that state, for local answers. Leave empty for a national answer.", "default": "" }, "googleLocation": { "title": "Google location", "type": "string", "description": "Where Google AI Overviews are checked from: a country, or a city as \"City,State,Country\" (for example \"Austin,Texas,United States\").", "default": "United States" }, "language": { "title": "Google language code", "type": "string", "description": "Two-letter language code for Google results.", "default": "en" } } }, "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 } } } } } } } } } }