{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Report: No API Key Needed", "description": "See whether AI search recommends your brand, with no API key or subscription. Enter your website: the Actor writes 30 buyer questions, asks Google Gemini with live Google Search, and returns an HTML report: mention and citation rates (95% CI), competitor share of voice, top cited sources.", "version": "0.1", "x-build-id": "pwejp93cfzdC1izHU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kyungminlee~ai-brand-visibility-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kyungminlee-ai-brand-visibility-report", "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/kyungminlee~ai-brand-visibility-report/runs": { "post": { "operationId": "runs-sync-kyungminlee-ai-brand-visibility-report", "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/kyungminlee~ai-brand-visibility-report/run-sync": { "post": { "operationId": "run-sync-kyungminlee-ai-brand-visibility-report", "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": [ "websiteUrl", "brandName" ], "properties": { "websiteUrl": { "title": "Website URL", "type": "string", "description": "Homepage of the brand to audit. The Actor reads the homepage and up to five key pages (about, products, pricing, blog) to understand what the brand sells." }, "brandName": { "title": "Brand name", "type": "string", "description": "How the brand is written in text, for example 'Apify'. Mentions are matched case-insensitively together with the website domain." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names that count as a brand mention (optional).", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor brand names to measure share of voice against (0-10).", "items": { "type": "string" } }, "businessDescription": { "title": "Business description", "type": "string", "description": "Optional one-paragraph description of what the brand offers and who buys it. Improves prompt generation; leave empty to rely on the crawled site." }, "language": { "title": "Question language", "enum": [ "English", "Korean", "Japanese", "Chinese", "German", "French", "Spanish", "Portuguese", "Italian", "Dutch", "Indonesian", "Vietnamese", "Thai", "Turkish", "Polish" ], "type": "string", "description": "Language the buyer questions are written in. Use the language of the market you want to measure; AI answers follow the question's language.", "default": "English" }, "promptCount": { "title": "Number of questions", "minimum": 5, "maximum": 40, "type": "integer", "description": "How many buyer-intent questions to generate (5-40), spread across best-of, comparison, how-to, pricing, trust and use-case questions. The price per report is the same for any size.", "default": 30 }, "samplesPerPrompt": { "title": "Answers per question", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many times each question is asked (1-3). AI answers vary between runs; 3 samples give tighter confidence intervals.", "default": 3 }, "demoMode": { "title": "Demo mode (free preview)", "type": "boolean", "description": "Generate the full report layout from simulated answers without calling the AI engine. Demo reports are free and clearly labelled. Uncheck this to get the real report from live Gemini + Google Search answers (charged once per report).", "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 } } } } } } } } } }