{ "openapi": "3.0.1", "info": { "title": "AI Rank Tracker - Brand Visibility in ChatGPT", "description": "Track your brand in ChatGPT answers with no key: mentions, rank, sentiment, cited sources. Other AI assistants with your own API key (unverified). Export CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "K2S8fkXrqyqprgzda" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~ai-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-ai-rank-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/parseforge~ai-rank-tracker/runs": { "post": { "operationId": "runs-sync-parseforge-ai-rank-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/parseforge~ai-rank-tracker/run-sync": { "post": { "operationId": "run-sync-parseforge-ai-rank-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": [ "queries", "brandName" ], "properties": { "queries": { "title": "Prompts to test", "type": "array", "description": "The questions your customers ask AI assistants, one per line, for example 'best CRM for small business'. Each prompt is sent to every selected platform.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "brandName": { "title": "Brand name", "type": "string", "description": "The brand to look for in every answer, for example 'HubSpot'. Matching is case-insensitive and whole-word." }, "brandDomain": { "title": "Brand domain", "type": "string", "description": "Your website, for example 'hubspot.com'. Lets the Actor tell whether the AI cites your own site as a source, not only names your brand." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings that count as a mention of your brand, for example 'Hub Spot'. Optional.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names or domains, for example 'Salesforce' or 'pipedrive.com'. Each one is counted in every answer, so you get rank and share of voice against them.", "items": { "type": "string" } }, "platforms": { "title": "AI platforms", "type": "array", "description": "Which assistants to ask. Each prompt on each platform is one check. ChatGPT needs no key. The '(API)' choices need the matching key below and call the provider directly.", "items": { "type": "string", "enum": [ "chatgpt", "openai_api", "gemini_api", "anthropic_api", "perplexity_api" ], "enumTitles": [ "ChatGPT (public web app, no key)", "ChatGPT via OpenAI API (your key)", "Gemini via Google API (your key)", "Claude via Anthropic API (your key)", "Perplexity via Sonar API (your key)" ] }, "default": [ "chatgpt" ] }, "repeatsPerPrompt": { "title": "Repeats per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers change from one ask to the next. Set 2 to 5 to ask every prompt several times and see how stable your visibility is. Each repeat is one more check.", "default": 1 }, "openaiKey": { "title": "OpenAI key", "type": "string", "description": "Needed for 'ChatGPT via OpenAI API'. The model uses OpenAI's web search tool." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Leave empty for gpt-4.1-mini. Must be a model that supports web search." }, "geminiKey": { "title": "Gemini key", "type": "string", "description": "Needed for 'Gemini via Google API'. Answers are grounded with Google Search." }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Leave empty for gemini-2.5-flash." }, "anthropicKey": { "title": "Anthropic key", "type": "string", "description": "Needed for 'Claude via Anthropic API'. The model uses Anthropic's web search tool." }, "anthropicModel": { "title": "Anthropic model", "type": "string", "description": "Leave empty for claude-haiku-4-5. Must be a model that supports web search." }, "perplexityKey": { "title": "Perplexity key", "type": "string", "description": "Needed for 'Perplexity via Sonar API'. Uses Perplexity's Sonar API with your key." }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "Leave empty for sonar." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings for ChatGPT.", "default": { "useApifyProxy": 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 } } } } } } } } } }