{ "openapi": "3.0.1", "info": { "title": "AEO Lite — Track My Brand in AI Search (3 Fields, No JSON)", "description": "Beginner-friendly AEO Citation Monitor. Type your brand, pick your industry, click Start. Same 6-engine AI search tracking (ChatGPT, Claude, Gemini, Perplexity, Grok, Google AI Overviews) — minimal-input form for non-technical users.", "version": "0.1", "x-build-id": "LvkGDY5gpWsZyv6ov" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/glaciological_hexahedron~aeo-citation-monitor-lite/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-glaciological_hexahedron-aeo-citation-monitor-lite", "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/glaciological_hexahedron~aeo-citation-monitor-lite/runs": { "post": { "operationId": "runs-sync-glaciological_hexahedron-aeo-citation-monitor-lite", "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/glaciological_hexahedron~aeo-citation-monitor-lite/run-sync": { "post": { "operationId": "run-sync-glaciological_hexahedron-aeo-citation-monitor-lite", "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", "industry", "acknowledgePublicBrandsOnly" ], "properties": { "brandName": { "title": "Your brand name", "type": "string", "description": "The brand you want to track. We'll automatically match common spelling variants." }, "brandWebsite": { "title": "Your brand's website (optional)", "type": "string", "description": "Used to detect when AI engines cite your own pages as sources. Just the domain, e.g., acme.com" }, "competitorNames": { "title": "Competitor brand names (optional)", "type": "array", "description": "One competitor per line. We'll track them in the same AI responses alongside your brand.", "default": [], "items": { "type": "string" } }, "industry": { "title": "Your industry", "enum": [ "saas-b2b", "ecommerce-d2c", "local-services", "agency", "media-publisher", "fintech" ], "type": "string", "description": "Pick the industry that best matches your business. We'll generate ~25 prompts customers might ask about brands in your space.", "default": "ecommerce-d2c" }, "category": { "title": "Category (one short phrase)", "type": "string", "description": "What kind of product/service is your brand? (e.g., 'CRM', 'running shoes', 'HVAC repair'). Used to fill prompt placeholders like 'best {category} for {audience}'." }, "country": { "title": "Country", "type": "string", "description": "Bias AI responses toward a country. ISO 3166-1 alpha-2 code (US, GB, DE, FR, JP, etc.).", "default": "US" }, "engines": { "title": "AI engines to query", "type": "array", "description": "Which AI search engines to check. All 6 covers the full landscape (~$0.36/prompt typical). Pick fewer for cheaper runs.", "default": [ "perplexity", "openai", "anthropic", "google-gemini", "xai-grok", "google-aio" ], "items": { "type": "string" } }, "acknowledgePublicBrandsOnly": { "title": "I confirm I'm tracking a public brand, not an individual person", "type": "boolean", "description": "REQUIRED. AI providers' usage policies prohibit using their APIs for surveillance or tracking of individuals.", "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 } } }, "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 } } } } } } } } } }