{ "openapi": "3.0.1", "info": { "title": "Google AI Overviews & AI Mode Tracker: Brand Mentions & Sources", "description": "Google AI Overviews and Google AI Mode tracker for SEO and GEO: check any prompt on live Google results and get the full AI Overview or AI Mode answer, cited sources, brand mentions, domain citations and rank vs competitors. $0.02 per AI Overview check, $0.03 per AI Mode answer.", "version": "0.1", "x-build-id": "SDLB4zASTkPyMMX3z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magenta_waterwheel~google-ai-overviews-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magenta_waterwheel-google-ai-overviews-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/magenta_waterwheel~google-ai-overviews-tracker/runs": { "post": { "operationId": "runs-sync-magenta_waterwheel-google-ai-overviews-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/magenta_waterwheel~google-ai-overviews-tracker/run-sync": { "post": { "operationId": "run-sync-magenta_waterwheel-google-ai-overviews-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": [ "prompts" ], "properties": { "prompts": { "title": "Prompts", "type": "array", "description": "Google searches or questions, one per line (up to 700 characters each). Each is checked once on every selected engine. Duplicates are removed.", "items": { "type": "string" } }, "engines": { "title": "Google AI engines", "type": "array", "description": "Google AI Overviews checks the AI Overview on a live Google results page (if Google shows none you get aiAnswerPresent: false). Google AI Mode returns the AI Mode answer. Empty = both.", "items": { "type": "string", "enum": [ "google_aio", "google_ai_mode" ], "enumTitles": [ "Google AI Overviews", "Google AI Mode" ] }, "default": [ "google_aio", "google_ai_mode" ] }, "brand": { "title": "Your brand", "type": "string", "description": "Brand or product name to look for in the answers (case-insensitive, whole words). Leave empty to just collect answers and sources." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names that count as a mention, for example \"Trello Premium\" or a former name.", "default": [], "items": { "type": "string" } }, "domain": { "title": "Your website domain", "type": "string", "description": "Domain to look for in the cited sources, like example.com. Subdomains (blog.example.com) count too." }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names. Each answer shows whether each one is mentioned and the order brands appear in (brandRank 1 = mentioned first).", "default": [], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Optional two-letter country code (US, GB, DE...) for the Google search location. Default US. Results are in English.", "default": "" }, "includeSources": { "title": "Include all retrieved sources", "type": "boolean", "description": "Add every source linked in the AI answer, not only the inline citations.", "default": true } } }, "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 } } } } } } } } } }