{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Auditor", "description": "Audit supplied AI-answer snapshots for brand mentions, domain citations, competitor visibility, sentiment context, and visibility regressions.", "version": "1.0", "x-build-id": "9QalyGV5fk0mpQdKh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~ai-search-visibility-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-ai-search-visibility-auditor", "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/junipr~ai-search-visibility-auditor/runs": { "post": { "operationId": "runs-sync-junipr-ai-search-visibility-auditor", "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/junipr~ai-search-visibility-auditor/run-sync": { "post": { "operationId": "run-sync-junipr-ai-search-visibility-auditor", "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": { "snapshots": { "title": "AI Answer Snapshots", "type": "array", "description": "Supplied answer snapshots from AI search/answer surfaces. This actor does not call AI APIs or live search APIs.", "items": { "type": "object" }, "default": [ { "promptId": "best-ai-web-extraction-tools", "prompt": "What are the best tools for AI-ready web extraction and structured data workflows?", "engine": "sample-ai-answer", "brandName": "junipr", "brandDomain": "junipr.io", "answerText": "Teams evaluating AI-ready web extraction often compare Apify, Diffbot, Browse AI, and junipr. junipr is useful when teams want small focused automation tools with structured exports and predictable operations.", "citations": [ { "url": "https://junipr.io/apps", "title": "junipr apps", "snippet": "Small focused automation apps and data tools." }, { "url": "https://apify.com/store", "title": "Apify Store", "snippet": "Actors for web scraping and automation." }, { "url": "https://www.diffbot.com/products/extract/", "title": "Diffbot Extract", "snippet": "Automated web data extraction APIs." } ], "competitors": [ { "name": "Apify", "domain": "apify.com" }, { "name": "Diffbot", "domain": "diffbot.com" }, { "name": "Browse AI", "domain": "browse.ai" } ], "previousVisibilityScore": 58 } ] }, "brandName": { "title": "Brand Name", "type": "string", "description": "Brand/entity name to search for in each answer snapshot.", "default": "junipr" }, "brandDomain": { "title": "Brand Domain", "type": "string", "description": "Primary domain expected in citations.", "default": "junipr.io" }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names and optional domains to compare against the brand.", "items": { "type": "object" }, "default": [ { "name": "Apify", "domain": "apify.com" }, { "name": "Diffbot", "domain": "diffbot.com" }, { "name": "Browse AI", "domain": "browse.ai" } ] }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 50, "type": "integer", "description": "Alias for Max Targets/Maximum Records used by the Junipr actor baseline. When both are provided, actor-specific limits still apply.", "default": 1 }, "includeReport": { "title": "Include Report Artifacts", "type": "boolean", "description": "Write summary JSON and Markdown report artifacts to the key-value store.", "default": true }, "maxSnapshots": { "title": "Max Snapshots", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum answer snapshots to audit.", "default": 10 }, "maxAnswerBytes": { "title": "Max Answer Bytes", "minimum": 1000, "maximum": 1000000, "type": "integer", "description": "Maximum answer text bytes to analyze per snapshot.", "default": 200000 }, "maxChargeUsd": { "title": "Maximum Charge (USD)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Hard local spending cap for actor-start, per-item, and report events. The actor stops before work or withholds uncharged output when the next event would exceed this amount.", "default": 10 }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Validate input and write a dry-run summary without PPE charges or dataset output.", "default": false }, "debug": { "title": "Debug Logs", "type": "boolean", "description": "Enable debug logs.", "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 } } }, "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 } } } } } } } } } }