{ "openapi": "3.0.1", "info": { "title": "Google SERP Rank & Visibility Monitor — PAA, Features + API", "description": "Track your Google organic rankings, People Also Ask, SERP features and competitor share of voice for a list of keywords. Change alerts + real-time REST API. Built on Apify's Google SERP proxy.", "version": "0.1", "x-build-id": "lHUdroF39lNU9gjA6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aileo~google-ai-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aileo-google-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/aileo~google-ai-visibility-monitor/runs": { "post": { "operationId": "runs-sync-aileo-google-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/aileo~google-ai-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-aileo-google-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords / search queries", "type": "array", "description": "The search queries to check. Question-style queries (\"how...\", \"best...\", \"what is...\") are most likely to trigger an AI Overview.", "default": [ "what is generative engine optimization", "best crm software for small business", "how to track brand visibility in ai search" ], "items": { "type": "string" } }, "targetDomain": { "title": "Your domain", "type": "string", "description": "The domain to score visibility for, e.g. \"example.com\" (no protocol). Leave empty to only map which domains Google cites, without scoring a specific site." }, "competitorDomains": { "title": "Competitor domains", "type": "array", "description": "Competitor domains for share-of-voice comparison, e.g. \"competitor.com\". Optional.", "items": { "type": "string" } }, "countryCode": { "title": "Country", "enum": [ "us", "gb", "ca", "au", "ie", "de", "at", "ch", "fr", "es", "it", "nl", "se", "in", "br", "mx", "jp" ], "type": "string", "description": "Country to search from (Google country domain + gl parameter).", "default": "us" }, "languageCode": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "nl", "sv", "pt", "hi", "ja" ], "type": "string", "description": "Interface / results language (Google hl parameter).", "default": "en" }, "device": { "title": "Device", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Emulate desktop or mobile results (AI Overviews and layout differ).", "default": "desktop" }, "topN": { "title": "Organic depth (top N)", "minimum": 1, "maximum": 100, "type": "integer", "description": "How deep to look for your domain in the organic results.", "default": 10 }, "includeAiOverview": { "title": "Include AI Overview", "type": "boolean", "description": "Extract the AI Overview block and its cited source domains. This is the core feature.", "default": true }, "includePaa": { "title": "Include People Also Ask", "type": "boolean", "description": "Extract People Also Ask questions.", "default": true }, "includeAiMode": { "title": "Include AI Mode (experimental, slower)", "type": "boolean", "description": "Also open Google's conversational AI Mode tab where available. Heavier and less stable — off by default.", "default": false }, "onlyChanged": { "title": "Only changed since last run", "type": "boolean", "description": "Monitoring mode: only output keywords whose visibility changed vs. the previous run (state persisted in a named store). Keep OFF for the first run so you get a full baseline.", "default": false }, "maxKeywords": { "title": "Max keywords per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper bound on keywords processed per run. Kept modest so a default run is cheap and always returns results.", "default": 25 } } }, "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 } } }, "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 } } } } } } } } } }