{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Tracker - Google AI Overview and AI Mode", "description": "Ask the questions your buyers ask and find out whether Google's AI answers name your brand, how early, whether they link you, and which competitors get named instead. One row per question per AI surface.", "version": "0.1", "x-build-id": "8004QT9LX1YdleZlL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~ai-brand-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-ai-brand-visibility", "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/s-r~ai-brand-visibility/runs": { "post": { "operationId": "runs-sync-s-r-ai-brand-visibility", "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/s-r~ai-brand-visibility/run-sync": { "post": { "operationId": "run-sync-s-r-ai-brand-visibility", "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", "prompts" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand to look for in the answers, written the way people write it." }, "brandDomain": { "title": "Brand domain", "type": "string", "description": "Your website, without https. Used to tell being named apart from being linked, which are different problems." }, "brandAliases": { "title": "Other spellings", "type": "array", "description": "Any other way the brand gets written. A name split across two words is already handled, so this is for genuinely different names such as a former one.", "items": { "type": "string" } }, "prompts": { "title": "Questions to ask", "type": "array", "description": "One buyer question per line, written the way someone would actually type it. These decide everything: a question nobody asks tells you nothing.", "items": { "type": "string" } }, "competitors": { "title": "Known competitors", "type": "array", "description": "Rivals to look for by name. Leave empty and the run reports whoever the answers cite and name instead of you.", "items": { "type": "string" } }, "engines": { "title": "AI surfaces", "type": "array", "description": "Which of Google's AI surfaces to ask. They are different products and answer differently, so both is the default.", "items": { "type": "string", "enum": [ "google_ai_overview", "google_ai_mode" ], "enumTitles": [ "Google AI Overview", "Google AI Mode" ] }, "default": [ "google_ai_overview", "google_ai_mode" ] }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code. AI answers are regional, so the same question names different brands per market.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code the answers come back in.", "default": "en" }, "concurrency": { "title": "Parallel checks", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many prompt-and-surface checks to run at once.", "default": 3 }, "retries": { "title": "Attempts per check", "minimum": 1, "maximum": 20, "type": "integer", "description": "How often to re-ask before accepting that a surface has no answer for a question. Google decides that per request, so a couple of retries is normal.", "default": 3 } } }, "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 } } } } } } } } } }