{ "openapi": "3.0.1", "info": { "title": "Brand AI Answers Tracker: ChatGPT brand visibility", "description": "Check if ChatGPT mentions your brand. Track AI brand visibility and share of voice: get the full dated answer, the cited sources and your rank against up to 5 competitors, counted by code. Pay per check.", "version": "1.0", "x-build-id": "0ZfgPi6l1mPrh4WxD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sillage-data~brand-ai-answers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sillage-data-brand-ai-answers", "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/sillage-data~brand-ai-answers/runs": { "post": { "operationId": "runs-sync-sillage-data-brand-ai-answers", "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/sillage-data~brand-ai-answers/run-sync": { "post": { "operationId": "run-sync-sillage-data-brand-ai-answers", "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": [ "brandName", "questions" ], "properties": { "brandName": { "title": "Brand name", "type": "string", "description": "The exact name of the brand to track, as people write it. Matching is whole word and case insensitive.", "default": "HubSpot" }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names that count as your brand (for example \"Hub Spot\" or \"HubSpot CRM\").", "default": [], "items": { "type": "string" } }, "brandDomain": { "title": "Brand website domain", "type": "string", "description": "Your website domain, without https://. Used to detect when the answer cites your site as a source (subdomains included).", "default": "hubspot.com" }, "competitors": { "title": "Competitors (up to 5)", "maxItems": 5, "type": "array", "description": "Competitor names, counted exactly like your brand.", "default": [ "Salesforce", "Zoho" ], "items": { "type": "string" } }, "questions": { "title": "Questions (1 to 50)", "minItems": 1, "maxItems": 50, "type": "array", "description": "The questions your customers ask an AI assistant. Each question x each sample is one check.", "default": [ "best CRM software for small business", "HubSpot vs Salesforce for a startup" ], "items": { "type": "string" } }, "samplesPerQuestion": { "title": "Answers per question", "minimum": 1, "maximum": 3, "type": "integer", "description": "AI answers vary. Ask each question 1 to 3 times to measure how often your brand shows up. Each extra answer is one more check.", "default": 1 }, "country": { "title": "Country", "enum": [ "US", "GB", "CA", "AU", "IE", "FR", "DE", "ES", "IT", "NL", "BE", "CH", "SE", "PL", "PT", "BR", "MX", "IN", "JP", "SG", "AE", "ZA" ], "type": "string", "description": "Approximate user location sent to the web search, as a two-letter country code.", "default": "US" }, "includeFullAnswer": { "title": "Include the full answer text", "type": "boolean", "description": "Keep the complete answer and the full list of consulted URLs in each row. Turn off for a lighter output (for AI agents or spreadsheets).", "default": true } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }