{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Monitor — ChatGPT, Gemini & Perplexity", "description": "Track whether YOUR brand shows up when users ask ChatGPT, Gemini or Perplexity about your product category. GEO/AEO monitoring with competitor comparison, sentiment hints and visibility-change alerts. BYO API keys.", "version": "1.0", "x-build-id": "y50lN6LfPJnsot5ep" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vertaizen~ai-brand-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vertaizen-ai-brand-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/vertaizen~ai-brand-visibility-monitor/runs": { "post": { "operationId": "runs-sync-vertaizen-ai-brand-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/vertaizen~ai-brand-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-vertaizen-ai-brand-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", "prompts" ], "properties": { "brand": { "title": "Brand to track", "type": "string", "description": "The brand name whose visibility you want to track in AI answers, e.g. `Notion`. Matching is case-insensitive with word boundaries." }, "competitors": { "title": "Competitor brands", "type": "array", "description": "Competitor brand names to compare against, e.g. `Evernote`, `Obsidian`. Used for mention position and competitor mention analysis.", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Prompts to test", "type": "array", "description": "The user questions to run against each AI provider, e.g. `What is the best note-taking app for teams?`. Each prompt is sent to every configured provider.", "items": { "type": "string" } }, "providers": { "title": "LLM providers & API keys (BYO keys)", "type": "object", "description": "Your own API keys per provider. Only providers with an `apiKey` are queried. Example: `{ \"openai\": { \"apiKey\": \"sk-...\", \"model\": \"gpt-5\" }, \"gemini\": { \"apiKey\": \"...\", \"model\": \"gemini-2.5-flash\" }, \"perplexity\": { \"apiKey\": \"pplx-...\", \"model\": \"sonar\" } }. Keys are stored encrypted (secret field) and never logged." }, "monitorMode": { "title": "Monitor mode — detect visibility changes", "type": "boolean", "description": "When enabled, the actor remembers the previous mention result per prompt+provider and adds a `changed` field (visibility gained/lost vs the last run). Ideal for scheduled runs with webhook alerts.", "default": false }, "temperature": { "title": "Temperature", "minimum": 0, "maximum": 2, "type": "number", "description": "Sampling temperature passed to each provider.", "default": 0.7 }, "includeFullAnswer": { "title": "Include full answer text", "type": "boolean", "description": "When enabled, each result item also contains the full raw answer (`fullAnswer`). Off by default to keep the dataset compact.", "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 } } } } } } } } } }