{ "openapi": "3.0.1", "info": { "title": "🔎 AI Brand Visibility Monitor", "description": "Track your AI brand's organic rankings across Google SERPs and Reddit threads. Extract precise rank deltas, competitor overlap, and social mentions.", "version": "0.1", "x-build-id": "BAP9D5DG9se6cgaXU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~ai-visibility-monitor-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-ai-visibility-monitor-actor", "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/taroyamada~ai-visibility-monitor-actor/runs": { "post": { "operationId": "runs-sync-taroyamada-ai-visibility-monitor-actor", "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/taroyamada~ai-visibility-monitor-actor/run-sync": { "post": { "operationId": "run-sync-taroyamada-ai-visibility-monitor-actor", "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", "keywords" ], "properties": { "brand": { "title": "Brand Name", "type": "string", "description": "Primary brand label used in summaries. Starter runs can be just your brand plus one keyword." }, "brandTerms": { "title": "Brand Match Terms", "type": "array", "description": "Terms that indicate your brand in titles/URLs, such as domains and product names. Starter mode usually needs just your domain + brand name." }, "competitors": { "title": "Competitors (optional)", "type": "array", "description": "Optional in starter mode. Leave empty for a brand-only first run, then add 1-3 competitors as the next upgrade for overlap context. Each item can be a string or an object with name and terms[]." }, "keywords": { "title": "Tracked Keywords", "type": "array", "description": "Keywords or prompts to monitor across search sources. Starter mode should begin with one high-intent keyword before expanding." }, "searchSources": { "title": "Search Sources", "type": "array", "description": "Sources to check for each keyword. Starter mode should stay Google-first; add Reddit only after the Google-first run is reliable." }, "requestTimeoutSeconds": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "HTTP timeout per request.", "default": 30 }, "maxResultsPerKeyword": { "title": "Max Results Per Keyword", "minimum": 5, "maximum": 20, "type": "integer", "description": "How many top results to inspect per keyword and source.", "default": 10 }, "userAgent": { "title": "Custom User-Agent", "type": "string", "description": "Optional custom user-agent header." }, "delivery": { "title": "Delivery Mode", "enum": [ "dataset", "webhook", "email" ], "type": "string", "description": "Where to send run results. Starter mode uses dataset. Advanced upgrades are email for recurring summaries or webhook for automation.", "default": "dataset" }, "datasetMode": { "title": "Dataset Mode", "enum": [ "changes_only", "all" ], "type": "string", "description": "Choose whether dataset/webhook sends all tracked items or only events. Starter mode should keep changes_only.", "default": "changes_only" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Required when delivery is webhook. Use this advanced option when changes should feed Slack, Zapier, or internal workflows." }, "emailTo": { "title": "Email Recipients", "type": "array", "description": "Required when delivery is email. Use this advanced option for weekly executive summaries to one or more recipients." }, "notifyOnNoChange": { "title": "Notify Even If No Change", "type": "boolean", "description": "Advanced recurring option. When false, webhook/email mode skips if no event items were produced.", "default": false }, "snapshotKey": { "title": "Snapshot Key", "type": "string", "description": "Storage key used for rank snapshots.", "default": "ai-visibility-snapshots" }, "nowIso": { "title": "Now (ISO, optional)", "type": "string", "description": "Optional fixed timestamp for deterministic tests." }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Skip delivery side effects and snapshot saves.", "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 } } } } } } } } } }