{ "openapi": "3.0.1", "info": { "title": "GEO / AEO Visibility Monitor", "description": "Track how brands appear in AI answers and search results. Measure brand mentions, citations, rankings, competitor visibility, and visibility changes across markets and queries.", "version": "0.0", "x-build-id": "cEkeofPZdqpfJ34GQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pummylee~geo-aeo-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pummylee-geo-aeo-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/pummylee~geo-aeo-visibility-monitor/runs": { "post": { "operationId": "runs-sync-pummylee-geo-aeo-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/pummylee~geo-aeo-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-pummylee-geo-aeo-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", "queries" ], "properties": { "brand": { "title": "Brand", "type": "object", "description": "Brand to monitor. Use name, aliases, and owned domains.", "default": { "name": "Example brand", "aliases": [], "domains": [] } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names, aliases, and domains.", "default": [] }, "queries": { "title": "Queries", "type": "array", "description": "Questions to ask search and AI search engines.", "default": [ "best project management software for small teams", "Example brand alternatives" ], "items": { "type": "string" } }, "markets": { "title": "Markets", "type": "array", "description": "Market objects with countryCode, languageCode, and optional location.", "default": [ { "countryCode": "US", "languageCode": "en" } ] }, "engines": { "title": "Source Actors", "type": "array", "description": "Apify source Actors to run. The default uses Apify Google Search Results Scraper.", "default": [ { "name": "google", "actorId": "apify/google-search-scraper" } ] }, "monitoringPreset": { "title": "Monitoring preset (AI add-ons cost extra)", "enum": [ "google_ai_mode", "google_ai_overview", "google_ai_full", "web_search", "custom" ], "type": "string", "description": "New Console inputs prefill Google AI Mode, which adds source-Actor charges. Web search disables Google AI Mode and full AI Overview capture. Custom preserves your advanced source options. Presets require apify/google-search-scraper. Saved inputs and API requests without this field default to custom, preserving their settings. No preset guarantees an AI answer for every query.", "default": "custom" }, "sourceActorInput": { "title": "Source Actor options", "type": "object", "description": "Advanced source fields. The selected Google preset controls aiModeSearch.enableAiMode and aiOverview.scrapeFullAiOverview; choose custom to manage these switches yourself or use another source Actor. Other AI add-ons require custom. Extra source charges apply according to the selected source Actor's pricing.", "default": {} }, "maxQueries": { "title": "Maximum queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard limit protecting the run from accidental cost growth.", "default": 50 }, "maxResultsPerQuery": { "title": "Maximum results per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of search result records to use for each query.", "default": 10 }, "maxTotalChargeUsd": { "title": "Maximum source Actor charge", "minimum": 0, "type": "number", "description": "Optional cap for EACH source run, further limited by the remaining aggregate source budget. Does not include this monitor's own compute/storage charges." }, "maxSourceBudgetUsd": { "title": "Total source budget (USD)", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Aggregate budget across source runs in this monitor run. Unknown charges consume their full reserved allowance. Monitor compute/storage charges are additional. Zero disables new source runs.", "default": 2 }, "maxSourceRuns": { "title": "Maximum source runs", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum source launch attempts across all queries, markets, and engines. Zero disables new launches.", "default": 20 }, "sourceTimeoutSeconds": { "title": "Source timeout (seconds)", "minimum": 5, "maximum": 900, "type": "integer", "description": "Platform timeout for each source run. Shortened when the monitor approaches its own timeout; active sources are aborted on local timeout when possible.", "default": 300 }, "monitorId": { "title": "Monitor project ID", "type": "string", "description": "Stable project identifier, for example notion-us. Use the same value on recurring runs to compare history. Different projects remain isolated.", "default": "default" }, "historyEnabled": { "title": "Enable persistent history", "type": "boolean", "description": "Create or reuse a named history store in your Apify account. Compare compatible observations from earlier completed runs. Requires normal storage creation permissions.", "default": true }, "historyRetentionDays": { "title": "History retention (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Delete this monitor project's older history records when it next runs. Named stores persist until explicitly cleaned or deleted.", "default": 90 }, "historyKey": { "title": "History key", "type": "string", "description": "History namespace, combined with monitorId. Kept for input compatibility; old run-local history arrays are not imported because their configuration cannot be verified.", "default": "GEO_HISTORY" }, "includeRawSource": { "title": "Include raw source data", "type": "boolean", "description": "Include the source record in each output item. This increases dataset size.", "default": false } } }, "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 } } } } } } } } } }