{ "openapi": "3.0.1", "info": { "title": "AI Visibility Monitor (Google AI Overview + Bing Copilot)", "description": "Use this Actor when you need to know if a brand shows up in Google AI Overviews or Bing Copilot answers for a list of questions: mention, position, competitors named, cited sources and what changed since the last check. Schedule it daily for alerts.", "version": "0.1", "x-build-id": "CkNtNBQ7c7yMMMz77" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/integrative_cafe_8pc~ai-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-integrative_cafe_8pc-ai-visibility-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/integrative_cafe_8pc~ai-visibility-monitor/runs": { "post": { "operationId": "runs-sync-integrative_cafe_8pc-ai-visibility-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/integrative_cafe_8pc~ai-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-integrative_cafe_8pc-ai-visibility-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", "questions" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand to look for in the AI answers, as people write it.", "default": "HubSpot" }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other names that count as a mention of your brand (product names, old names, abbreviations).", "items": { "type": "string" } }, "brandDomain": { "title": "Brand website domain", "type": "string", "description": "Your domain, like hubspot.com. Used to tell whether the AI answer cites your own site.", "default": "hubspot.com" }, "questions": { "title": "Questions / prompts", "type": "array", "description": "Questions your customers ask, one per line. Each question is checked on each engine.", "default": [ "best crm for small business", "best free crm software" ], "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names to find in the same answers. The output says which ones were mentioned and in which order.", "default": [ "Salesforce", "Zoho", "Pipedrive", "Freshsales", "Monday" ], "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Which AI answers to check. Both work without any login. Perplexity and ChatGPT are coming soon.", "items": { "type": "string", "enum": [ "google_ai_overview", "bing_copilot" ], "enumTitles": [ "Google AI Overviews", "Bing Copilot Search" ] }, "default": [ "google_ai_overview", "bing_copilot" ] }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code for the search, like us, gb, de, br.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Interface language code, like en, de, pt-BR.", "default": "en" }, "monitorId": { "title": "Monitor name", "type": "string", "description": "Name of the history kept between runs (a named key-value store in your account). Defaults to the brand name. Use different names to track separate projects for the same brand." }, "webhookUrl": { "title": "Webhook URL for changes", "type": "string", "description": "Optional. Every change since the last run is POSTed here as JSON with 'text' and 'content' fields, so Slack and Discord webhooks work as is." }, "onlyChanges": { "title": "Only output changes", "type": "boolean", "description": "If on, the dataset only gets checks whose result changed since the last run (and first checks). History is still updated for every check.", "default": false }, "maxConcurrency": { "title": "Parallel browser pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many Bing Copilot answers load at the same time.", "default": 3 }, "proxy": { "title": "Proxy", "type": "object", "description": "Proxy for Bing Copilot. Residential is recommended; every blocked attempt retries on a new IP. Google AI Overviews always go through Apify's Google SERP proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }