{ "openapi": "3.0.1", "info": { "title": "AEO Visibility Audit", "description": "Find out whether ChatGPT, Perplexity, and Google's AI recommend your business — or your competitors. Get an AI visibility score, the real Google AI Overview, the exact sources AI cites, competitor share-of-voice, and a prioritized action plan. One URL in, structured JSON out.", "version": "1.0", "x-build-id": "hQp0d4OE8n074L9ki" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swholmes~aeo-visibility-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swholmes-aeo-visibility-audit", "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/swholmes~aeo-visibility-audit/runs": { "post": { "operationId": "runs-sync-swholmes-aeo-visibility-audit", "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/swholmes~aeo-visibility-audit/run-sync": { "post": { "operationId": "run-sync-swholmes-aeo-visibility-audit", "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": [ "url" ], "properties": { "url": { "title": "Business URL", "type": "string", "description": "Homepage to audit" }, "preset": { "title": "Pricing preset (flat per-audit mode)", "enum": [ "custom", "quick", "standard", "deep" ], "type": "string", "description": "Pick a fixed-price bundle, or 'custom' to bill per check (metered mode) using the fields below.", "default": "standard" }, "city": { "title": "City", "type": "string", "description": "City the business serves. Used to localize the generated buyer-intent prompts and the AI Overview SERP." }, "province": { "title": "Province / State (abbrev ok)", "type": "string", "description": "Province or state (abbreviation is fine, e.g. ON). Used to localize prompts and SERP results." }, "country": { "title": "Country", "type": "string", "description": "Country used for the AI search-volume lookup and SERP location.", "default": "Canada" }, "brand": { "title": "Brand name override", "type": "string", "description": "Blank = auto-detect from og:site_name" }, "industry": { "title": "Industry / category override", "type": "string", "description": "Optional: force the business category used to build prompts (e.g. 'AI receptionist service', 'roofing company'). Blank = auto-detect." }, "engines": { "title": "LLM engines", "type": "array", "description": "Which AI answer engines to query: ChatGPT, Perplexity, and/or Google (Gemini).", "items": { "type": "string", "enum": [ "chat_gpt", "perplexity", "gemini" ] }, "default": [ "chat_gpt", "perplexity", "gemini" ] }, "maxPrompts": { "title": "Max prompts (per engine)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of prompts per engine (custom mode; presets set this automatically).", "default": 12 }, "includeAiOverview": { "title": "Include real Google AI Overview (SERP)", "type": "boolean", "description": "Runs DataForSEO SERP with load_async_ai_overview for the true AI Overview + local pack", "default": true }, "serpMaxKeywords": { "title": "AI Overview keywords to check", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many top buyer-intent keywords to check for the real Google AI Overview.", "default": 6 }, "serpLocation": { "title": "Exact DataForSEO location_name (optional)", "type": "string", "description": "e.g. \"Barrie,Ontario,Canada\". Overrides city/province/country if set." }, "cache": { "title": "Use shared cache", "type": "boolean", "description": "Reuse a stored result for the same URL; auto-refreshes after the 1st and 15th of each month", "default": true }, "forceRefresh": { "title": "Force refresh (ignore cache)", "type": "boolean", "description": "Ignore the cache and run a fresh audit even if a cached result exists.", "default": false }, "dataforseoLogin": { "title": "DataForSEO login (email)", "type": "string", "description": "Optional bring-your-own-key: your DataForSEO account email. Leave blank to use the Actor's bundled credentials." }, "dataforseoPassword": { "title": "DataForSEO password", "type": "string", "description": "Optional bring-your-own-key: your DataForSEO account password (or API password)." }, "includeAiSearchVolume": { "title": "Include AI search volume", "type": "boolean", "description": "Look up real LLM prompt-demand volume (DataForSEO AI Keyword Data) for each tracked prompt. Adds ~$0.01 per run. Returns null for hyperlocal long-tail prompts with no data.", "default": true }, "fastModels": { "title": "Use fast/cheap models (custom mode)", "type": "boolean", "description": "Custom mode only: use gpt-4o-mini etc. Presets set this automatically.", "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 } } }, "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 } } } } } } } } } }