{ "openapi": "3.0.1", "info": { "title": "AI Brand Monitoring - Track Mentions & Citations | 30% Off", "description": "AI brand monitoring for indexed LLM answers. Enter domain or keyword targets and get flat mention rows with question, answer, platform, sources, and citations. One dataset row per mention, not a nested report. Index lookup only. No live prompts.", "version": "0.0", "x-build-id": "PCB5pOBVOpEKeYHN1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winningsolutions~llm-mentions-index/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winningsolutions-llm-mentions-index", "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/winningsolutions~llm-mentions-index/runs": { "post": { "operationId": "runs-sync-winningsolutions-llm-mentions-index", "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/winningsolutions~llm-mentions-index/run-sync": { "post": { "operationId": "run-sync-winningsolutions-llm-mentions-index", "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", "properties": { "domains": { "title": "Domains", "maxItems": 10, "type": "array", "description": "Domains to look up in the mention index. One hostname per entry, not a full URL. Example: apple.com. Combine with keywords. After cleanup the two lists together must have 1-10 targets.", "items": { "type": "string", "maxLength": 253 }, "default": [] }, "keywords": { "title": "Keywords", "maxItems": 10, "type": "array", "description": "Brand or term targets in the mention index. Not a live prompt. One term per entry. Combine with domains. After cleanup the two lists together must have 1-10 targets.", "items": { "type": "string", "maxLength": 200 }, "default": [] }, "location": { "title": "Location", "type": "string", "description": "Geographic market of the indexed answers. Example: United States. Must match a known market name. A typo fails. Default United States.", "default": "United States" }, "language": { "title": "Language", "type": "string", "description": "Language code of the indexed answers. Example: en. Must be valid for the chosen location. Names such as English fail. Default en.", "default": "en" }, "platform": { "title": "Platform", "enum": [ "both", "chat_gpt", "google" ], "type": "string", "description": "Which index platform to query. both uses every platform available for the location and language. chat_gpt is available for United States and English only. Other markets use google.", "default": "both" }, "searchFilter": { "title": "Search filter", "enum": [ "include", "exclude" ], "type": "string", "description": "include keeps mentions that hit the targets. exclude keeps mentions that miss the targets. This is still a mention lookup, not a competitor report.", "default": "include" }, "searchScope": { "title": "Search scope", "enum": [ "any", "question", "answer", "sources", "search_results", "brand_entities", "fan_out_queries" ], "type": "string", "description": "Where the target must appear in the mention. any searches all allowed fields. Domain-only runs accept any, sources, search_results. Keyword-only runs accept any, question, answer, brand_entities, fan_out_queries. Mixed targets accept any only.", "default": "any" }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "When true, the lookup includes subdomains of the domain targets. Default is off. The Actor does not add www or other variants itself. Ignored when the run has no domain target.", "default": false }, "matchType": { "title": "Match type", "enum": [ "word_match", "partial_match" ], "type": "string", "description": "How keywords match. word_match treats the keyword as a whole word. partial_match treats it as a substring. Domain matching stays unchanged. Ignored when the run has no keyword.", "default": "word_match" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum mention rows to write. Range 1-5000. Default 100. Apify Free plan: 100 mention rows per run.", "default": 100 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum index pages to fetch. Range 1-10. Default 5. Stops the search even if fewer mention rows exist. Apify Free plan: 1 page.", "default": 5 } } }, "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 } } } } } } } } } }