{ "openapi": "3.0.1", "info": { "title": "Review Intelligence Analyzer", "description": "Turn customer reviews into sentiment, themes, pain points, feature requests, competitor mentions, evidence quotes, and prioritized actions. Accepts direct input or any Apify dataset and exports JSON, Markdown, and HTML.", "version": "0.0", "x-build-id": "FhF3Rg42i2mfbMAZv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalforge_labs~review-intelligence-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalforge_labs-review-intelligence-analyzer", "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/signalforge_labs~review-intelligence-analyzer/runs": { "post": { "operationId": "runs-sync-signalforge_labs-review-intelligence-analyzer", "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/signalforge_labs~review-intelligence-analyzer/run-sync": { "post": { "operationId": "run-sync-signalforge_labs-review-intelligence-analyzer", "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": { "sourceType": { "title": "One-click source", "enum": [ "none", "googleMaps", "youtube" ], "type": "string", "description": "Choose a source Actor to collect reviews/comments automatically. Source Actor charges are billed separately by Apify. Select Direct input / dataset to use the fields below without calling another Actor.", "default": "none" }, "sourceUrls": { "title": "Google Maps or YouTube URLs", "type": "array", "description": "Add Google Maps place URLs or YouTube video URLs matching the selected one-click source.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sourceMaxItems": { "title": "Maximum items per URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum reviews or comments requested from the selected source Actor for each URL.", "default": 100 }, "sourceSort": { "title": "Source sorting", "enum": [ "newest", "top", "highest", "lowest" ], "type": "string", "description": "Newest and top work for both sources. Highest and lowest are used for Google Maps reviews.", "default": "newest" }, "reviews": { "title": "Reviews", "type": "array", "description": "Paste review objects. Common fields such as text, reviewText, content, comment, rating, stars, url, and reviewUrl are detected automatically." }, "datasetId": { "title": "Source Apify dataset ID", "type": "string", "description": "Optional dataset ID. Items from it are appended to reviews pasted above." }, "textField": { "title": "Custom text field", "type": "string", "description": "Optional dot-path such as review.text. Leave empty for automatic detection." }, "ratingField": { "title": "Custom rating field", "type": "string", "description": "Optional dot-path such as review.rating." }, "urlField": { "title": "Custom URL field", "type": "string", "description": "Optional dot-path containing the evidence URL." }, "competitorNames": { "title": "Competitor names", "type": "array", "description": "Optional competitor or alternative names to track in reviews.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum reviews", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of reviews to analyze in one run.", "default": 5000 }, "evidencePerTheme": { "title": "Evidence quotes per theme", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of representative review quotes to keep for each detected theme.", "default": 3 }, "outputLanguage": { "title": "Report language", "enum": [ "en", "zh" ], "type": "string", "description": "Language used for report labels and recommendations.", "default": "en" } } }, "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 } } } } } } } } } }