{ "openapi": "3.0.1", "info": { "title": "ChatGPT Brand Visibility Tracker (AI SEO / GEO)", "description": "Track whether ChatGPT mentions, ranks and cites your brand vs competitors for buyer prompts. Official OpenAI API with web search: mention rate, position, sentiment, cited URLs, share of voice, visibility score, baseline diff. No API key needed.", "version": "0.1", "x-build-id": "klCrshMT6ycesdq7z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hanielazevedo~ai-search-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hanielazevedo-ai-search-tracker", "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/hanielazevedo~ai-search-tracker/runs": { "post": { "operationId": "runs-sync-hanielazevedo-ai-search-tracker", "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/hanielazevedo~ai-search-tracker/run-sync": { "post": { "operationId": "run-sync-hanielazevedo-ai-search-tracker", "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" ], "properties": { "brand": { "title": "Your brand", "type": "string", "description": "Brand to track. A name, a domain, or \"Name | alias | domain.com\" (aliases improve matching; the domain is used to detect when ChatGPT cites your site)." }, "brandAliases": { "title": "Extra brand aliases", "type": "array", "description": "Other spellings or product names that count as your brand (e.g. \"HubSpot CRM\").", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Up to 20 competitors, same format as the brand: \"Name | alias | domain.com\". Used for share of voice and ranking.", "items": { "type": "string" } }, "keywords": { "title": "Keywords / topics", "type": "array", "description": "Topics your buyers ask about. Each keyword becomes realistic prompts (see \"Prompt variants per keyword\"). Your brand is never inserted into the prompt.", "items": { "type": "string" } }, "prompts": { "title": "Exact prompts", "type": "array", "description": "Questions to ask ChatGPT word for word, in addition to the keyword prompts.", "items": { "type": "string" } }, "promptVariants": { "title": "Prompt variants per keyword", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many phrasings to generate for each keyword (\"best ...\", \"which ... do you recommend\", \"... compared\", ...).", "default": 3 }, "language": { "title": "Answer language", "enum": [ "en", "pt", "es", "fr", "de", "it", "nl", "pl", "ja" ], "type": "string", "description": "Language ChatGPT answers in. Keyword prompt templates exist for English, Portuguese and Spanish (other languages use the English templates; exact prompts are sent as written).", "default": "en" }, "country": { "title": "Country (web search location)", "type": "string", "description": "Two-letter ISO country code used as the approximate searcher location (e.g. US, BR, GB). Leave empty for no location.", "default": "US" }, "webSearch": { "title": "Use web search (like ChatGPT search)", "type": "boolean", "description": "On: ChatGPT searches the web and cites sources (what most users see today). Off: answer from model memory only (cheaper event, no citations).", "default": true }, "model": { "title": "Model", "enum": [ "gpt-6-luna", "gpt-5.6-luna", "gpt-5-mini" ], "type": "string", "description": "OpenAI model used to answer. Same price per check for every model.", "default": "gpt-6-luna" }, "samplesPerPrompt": { "title": "Samples per prompt", "minimum": 1, "maximum": 3, "type": "integer", "description": "AI answers vary. Ask each prompt up to 3 times for a steadier mention rate. Each sample is one check.", "default": 1 }, "analysisMode": { "title": "Brand extraction", "enum": [ "llm", "rules" ], "type": "string", "description": "AI extraction lists every brand the answer names, so positions count unknown competitors too. Rules only matches your tracked names.", "default": "llm" }, "maxChecks": { "title": "Max checks", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on checks (prompts x samples) in this run. Each successful check is one charged event.", "default": 50 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Checks run in parallel.", "default": 5 }, "baselineStoreName": { "title": "History store name", "type": "string", "description": "Optional named key-value store in your account. The run compares results with the last run saved there and reports what changed." }, "saveBaseline": { "title": "Save this run as the new baseline", "type": "boolean", "description": "Only used with a history store name.", "default": true }, "engines": { "title": "AI engines", "type": "array", "description": "Currently ChatGPT only.", "items": { "type": "string", "enum": [ "chatgpt" ], "enumTitles": [ "ChatGPT (OpenAI)" ] }, "default": [ "chatgpt" ] }, "mockMode": { "title": "Demo mode (synthetic answers, free)", "type": "boolean", "description": "Generates realistic synthetic answers without calling OpenAI, to preview the output format. Never charged, max 20 checks. Results are NOT real ChatGPT data.", "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 }, "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 } } } } } } } } } }