{ "openapi": "3.0.1", "info": { "title": "Google AI Overview Tracker — Citation Checker", "description": "AEO & GEO tool for Google AI Overviews: see which searches show an AI Overview, whether your site is cited, every cited source, competitor domains and brand mentions. Track AI search visibility and citation changes over time. Input: keywords + your domain. Output: one row per keyword.", "version": "0.3", "x-build-id": "R2uMNnpaJfilmmmyc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automationnation~aeo-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automationnation-aeo-auditor", "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/automationnation~aeo-auditor/runs": { "post": { "operationId": "runs-sync-automationnation-aeo-auditor", "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/automationnation~aeo-auditor/run-sync": { "post": { "operationId": "run-sync-automationnation-aeo-auditor", "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", "targetDomain" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "Keywords or questions to check, exactly as people search them, e.g. [\"best crm for small business\", \"how to fix a leaking tap\"]. One result row per query.", "items": { "type": "string" } }, "targetDomain": { "title": "Your domain", "type": "string", "description": "The website to look for among the AI Overview citations, e.g. \"yourbrand.com\". Subdomains count (blog.yourbrand.com); look-alike domains don't." }, "maxQueries": { "title": "Max queries", "minimum": 0, "type": "integer", "description": "Only the first N queries are checked (0 = check all). Each checked query is one billable result.", "default": 3 }, "country": { "title": "Google country", "type": "string", "description": "Two-letter country code for the Google results, e.g. \"us\", \"gb\", \"de\". AI Overviews differ by country.", "default": "us" }, "language": { "title": "Google language", "type": "string", "description": "Interface language code, e.g. \"en\", \"de\", \"fr\".", "default": "en" }, "brandNames": { "title": "Brand names to look for in the answer", "type": "array", "description": "Optional. Names that count as a mention when they appear in the AI Overview text, even without a link, e.g. [\"Acme\", \"Acme CRM\"].", "default": [], "items": { "type": "string" } }, "competitorDomains": { "title": "Competitor domains", "type": "array", "description": "Optional. Competitor websites to watch, e.g. [\"hubspot.com\", \"pipedrive.com\"]. Each row shows which of them the AI Overview cited.", "default": [], "items": { "type": "string" } }, "fetchMode": { "title": "Fetch method", "enum": [ "auto", "http", "browser" ], "type": "string", "description": "Automatic reads most results pages over plain HTTP, which is several times faster, and uses a browser only for AI Overviews that Google loads late or pages that couldn't be read. Results are the same either way.", "default": "auto" }, "generateReport": { "title": "Client-ready HTML report", "type": "boolean", "description": "Save a shareable report (REPORT in the key-value store): AI Overview coverage, citation rate and position, gains and losses, keyword by keyword, and the domains cited instead.", "default": true }, "alertWebhookUrl": { "title": "Alert webhook URL", "type": "string", "description": "Get a message when citations are gained or lost: a Slack or Discord webhook URL, or any Zapier, Make, n8n or HTTPS endpoint (which receives JSON)." }, "alertOn": { "title": "Send alerts", "enum": [ "changes", "always" ], "type": "string", "description": "When to send the alert.", "default": "changes" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for Google Search. Automatic (default) uses residential IPs in your Google country — the setup that gets through Google reliably — and falls back to datacenter IPs if residential isn't available. Pick a group to force it.", "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 } } } } } } } } } }