{ "openapi": "3.0.1", "info": { "title": "AI Shopping Tracker: Products ChatGPT & AI Recommend", "description": "Which products, brands and shops ChatGPT, Perplexity, Gemini, Claude, Grok and Google's AI Overview recommend when shoppers ask what to buy, in order, with prices and reasons, and whether yours are among them.", "version": "0.1", "x-build-id": "mEJsYx24tvPw0oYov" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~ai-shopping-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-ai-shopping-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/zaiq~ai-shopping-tracker/runs": { "post": { "operationId": "runs-sync-zaiq-ai-shopping-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/zaiq~ai-shopping-tracker/run-sync": { "post": { "operationId": "run-sync-zaiq-ai-shopping-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", "properties": { "questions": { "title": "Shopping questions", "type": "array", "description": "What shoppers ask AI assistants, one per line: 'best robot vacuum for pet hair', 'running shoes under $120 for beginners'.", "items": { "type": "string" } }, "brands": { "title": "Your brands", "type": "array", "description": "Brands to look for in the recommendations, one per line: 'Brand' or 'Brand | brand.example'.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Each engine's newest model is used.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini", "claude", "grok", "google-ai-overview" ], "enumTitles": [ "ChatGPT (OpenAI GPT, web search)", "Perplexity", "Google Gemini (Google Search grounding)", "Anthropic Claude (web search)", "xAI Grok (web search)", "Google AI Overview" ] }, "default": [ "openai", "perplexity", "gemini" ] }, "country": { "title": "Shopper's country", "type": "string", "description": "Two-letter country code: answers and prices follow it where the engine allows.", "default": "US" }, "language": { "title": "Language (Google AI Overview)", "type": "string", "description": "Optional, e.g. en, de." }, "maxAnswerTokens": { "title": "Answer length cap", "minimum": 500, "maximum": 2048, "type": "integer", "description": "Tokens per answer.", "default": 2000 }, "maxConcurrency": { "title": "Answers at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "Answers asked in parallel.", "default": 4 }, "includeReport": { "title": "Create visibility report", "type": "boolean", "description": "Opt in to REPORT.html, competitor gaps and evidence-based recommendations. No extra event or model call. The first tracked brand is the subject; remaining brands are competitors. Public cited pages may be read directly.", "default": false }, "projectName": { "title": "Monitoring project (optional)", "type": "string", "description": "Opt in to reports and persistent run history in a named key-value store. Reuse exactly the same project name for comparisons; schedule runs sequentially. Failed or incomparable answers do not become losses." }, "maxCitedPages": { "title": "Cited pages to inspect", "minimum": 0, "maximum": 12, "type": "integer", "description": "Maximum public cited pages read for recommendations when reporting is enabled. Zero uses citation URLs only and labels coverage unknown. No proxy or AI calls are used.", "default": 8 } } }, "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 } } } } } } } } } }