{ "openapi": "3.0.1", "info": { "title": "Review Sentiment Analyzer: Bulk Sentiment & Topic Tags", "description": "Add sentiment score, label, topics and defect flags to reviews you already have. Paste reviews or point to any Apify dataset. Rule-based, 5 languages, no LLM costs, no scraping.", "version": "0.0", "x-build-id": "ynYr0JeNy7r3gV32Q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jobdata_labs~review-sentiment-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jobdata_labs-review-sentiment-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/jobdata_labs~review-sentiment-analyzer/runs": { "post": { "operationId": "runs-sync-jobdata_labs-review-sentiment-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/jobdata_labs~review-sentiment-analyzer/run-sync": { "post": { "operationId": "run-sync-jobdata_labs-review-sentiment-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": { "reviews": { "title": "Reviews", "type": "array", "description": "Reviews to analyze. Each item is either a plain text string or an object with a text field and, optionally, a title, a rating and an ID. Leave empty if you use a dataset instead." }, "datasetId": { "title": "Dataset with reviews", "type": "string", "description": "ID or name of an Apify dataset from your account that contains reviews, for example the output of a review scraper you already ran. It is read only; results go to this run's own dataset." }, "textField": { "title": "Text field", "type": "string", "description": "Name of the field holding the review text. Dot paths such as review.body are supported. Leave empty to auto-detect common names (text, reviewText, review, body, content, comment)." }, "titleField": { "title": "Title field", "type": "string", "description": "Name of the field holding the review title or headline. Leave empty to auto-detect (title, reviewTitle, headline)." }, "ratingField": { "title": "Rating field", "type": "string", "description": "Name of the field holding the star rating. Numbers and strings such as '4.0 out of 5 stars' both work. Leave empty to auto-detect (rating, stars, ratingScore, score)." }, "idField": { "title": "ID field", "type": "string", "description": "Name of the field holding the review ID, copied to the output so you can join results back to your data. Leave empty to auto-detect (id, reviewId)." }, "ratingScale": { "title": "Rating scale maximum", "minimum": 2, "maximum": 100, "type": "integer", "description": "Highest possible rating in your data: 5 for stars, 10 for a 1-10 scale.", "default": 5 }, "maxItems": { "title": "Max reviews to analyze", "minimum": 0, "type": "integer", "description": "Stop after this many reviews. You are charged only for reviews actually analyzed. Set to 0 for no limit.", "default": 1000 }, "keepFields": { "title": "Extra fields to copy to the output", "type": "array", "description": "Field names from your data to copy unchanged to each result, for example productId or date. By default only the ID, title, text and rating are kept, so reviewer names and other personal data are not carried over.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }