{ "openapi": "3.0.1", "info": { "title": "Review Sentiment Typology Analyzer", "description": "Classifies customer reviews into types: Technical Critics, Emotional Storytellers, Comparison Shoppers, Deal Hunters, Brand Loyalists, and Cautious Researchers. For ecommerce brands, product managers, market researchers understand what customers think, who they are and how to reach them effectively", "version": "1.0", "x-build-id": "NgyUYJxsNkEBjQCFp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/passionate_niagara~review-sentiment-typology-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-passionate_niagara-review-sentiment-typology-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/passionate_niagara~review-sentiment-typology-analyzer/runs": { "post": { "operationId": "runs-sync-passionate_niagara-review-sentiment-typology-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/passionate_niagara~review-sentiment-typology-analyzer/run-sync": { "post": { "operationId": "run-sync-passionate_niagara-review-sentiment-typology-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs of review pages to scrape", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviews": { "title": "Maximum Reviews", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of reviews to scrape across all URLs", "default": 1000 }, "enableSentiment": { "title": "Enable Sentiment Analysis", "type": "boolean", "description": "Perform sentiment analysis on review text", "default": true }, "enableTypology": { "title": "Enable Typology Classification", "type": "boolean", "description": "Classify reviews into typology categories (Technical Critic, Emotional Storyteller, etc.)", "default": true }, "useEnhancedClassifier": { "title": "Use Enhanced Classifier", "type": "boolean", "description": "Use ML-inspired classifier with linguistic features and calibrated confidence scores (recommended). If disabled, falls back to simple keyword matching. Only applies if useMLModel is false.", "default": true }, "useMLModel": { "title": "Use Trained ML Model", "type": "boolean", "description": "Use trained machine learning model (TF-IDF + Logistic Regression) for classification. Provides highest accuracy (trained on 3000 reviews). If enabled, overrides useEnhancedClassifier.", "default": false }, "typologyCategories": { "title": "Typology Categories", "type": "array", "description": "Select which typology categories to analyze" }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only scrape reviews with rating >= this value (leave empty for all ratings)" }, "maxRating": { "title": "Maximum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only scrape reviews with rating <= this value (leave empty for all ratings)" }, "selectors": { "title": "CSS Selectors", "type": "object", "description": "Custom CSS selectors for extracting review elements from the page" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings to avoid blocking. Recommended for large-scale scraping." }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of concurrent requests (higher = faster but more resource intensive)", "default": 5 }, "requestDelay": { "title": "Request Delay", "minimum": 0, "maximum": 60, "type": "number", "description": "Delay between requests in seconds (helps avoid rate limiting)", "default": 1 }, "includeImages": { "title": "Include Review Images", "type": "boolean", "description": "Extract image URLs from reviews (if available)", "default": false }, "maxDepth": { "title": "Max Pagination Depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of pages to follow (1 = first page only, 10 = up to 10 pages)", "default": 1 }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Enable verbose logging for troubleshooting", "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 } } } } } } } } } }