{ "openapi": "3.0.1", "info": { "title": "Google AI Mode & AI Overview Tracker", "description": "Get Google AI Mode and AI Overview answers with their cited sources for any query and country, and see whether your brand and competitors are mentioned or cited. Pay only for answers delivered.", "version": "0.1", "x-build-id": "kNZpqenoD1LgXoLgy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leanpilar~google-ai-answer-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leanpilar-google-ai-answer-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/leanpilar~google-ai-answer-tracker/runs": { "post": { "operationId": "runs-sync-leanpilar-google-ai-answer-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/leanpilar~google-ai-answer-tracker/run-sync": { "post": { "operationId": "run-sync-leanpilar-google-ai-answer-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": [ "queries" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "What people would ask Google, one per line. Write them in the language you set below.", "items": { "type": "string" } }, "brands": { "title": "Brands to track (optional)", "type": "array", "description": "One brand per line: name, then other spellings and the website, comma separated. Example: \"HubSpot, hubspot.com\" or \"Zoho CRM, Zoho, zoho.com\". The website is used to check if the brand is cited as a source.", "items": { "type": "string" } }, "answerTypes": { "title": "Answer types", "type": "array", "description": "AI Overview is the AI summary at the top of normal Google results. AI Mode is Google's chat-style AI search. Each answer is charged separately.", "items": { "type": "string", "enum": [ "aiOverview", "aiMode" ], "enumTitles": [ "AI Overview", "AI Mode" ] }, "default": [ "aiOverview", "aiMode" ] }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes, e.g. US, GB, DE, HR. Each query runs once per country.", "default": [ "US" ], "items": { "type": "string" } }, "language": { "title": "Language", "type": "string", "description": "Google interface language code, e.g. en, de, hr, es. AI answers usually follow the language of the query.", "default": "en" }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches run at once. Higher is faster but more likely to be blocked.", "default": 4 }, "maxAttempts": { "title": "Attempts per search", "minimum": 1, "maximum": 10, "type": "integer", "description": "Retries with a new IP when Google blocks a request. Failed searches are not charged.", "default": 4 }, "includeHtml": { "title": "Include page HTML", "type": "boolean", "description": "Add the full page HTML to each result (large). Useful for your own parsing.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy works best. Residential proxy is blocked by Google more often for this.", "default": { "useApifyProxy": 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 } } } } } } } } } }