{ "openapi": "3.0.1", "info": { "title": "Trustpilot Review Scraper", "description": "Trustpilot review scraper that collects star ratings, review text, and reviewer details from any company page, so marketers and analysts can monitor brand reputation and run sentiment analysis without manual data collection.", "version": "0.0", "x-build-id": "c8iWp0oqhxfiFK7GQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zerobreak~trustpilot-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zerobreak-trustpilot-review-scraper", "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/zerobreak~trustpilot-review-scraper/runs": { "post": { "operationId": "runs-sync-zerobreak-trustpilot-review-scraper", "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/zerobreak~trustpilot-review-scraper/run-sync": { "post": { "operationId": "run-sync-zerobreak-trustpilot-review-scraper", "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": [ "companyDomain" ], "properties": { "companyDomain": { "title": "Company domain or Trustpilot URL", "type": "string", "description": "The company domain as registered on Trustpilot (e.g. www.amazon.com) or the full Trustpilot profile URL (e.g. https://www.trustpilot.com/review/www.amazon.com). Note: many companies are registered with the www. prefix on Trustpilot." }, "maxReviews": { "title": "Max reviews", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of reviews to collect per run. Capped at 1000. Works together with startPage and endPage.", "default": 100 }, "startPage": { "title": "Start page", "minimum": 1, "type": "integer", "description": "Page number to start scraping from. Default is 1. Set higher to skip earlier pages.", "default": 1 }, "endPage": { "title": "End page", "minimum": 0, "type": "integer", "description": "Page number to stop at (inclusive). Set to 0 to disable this limit and let maxReviews control the run.", "default": 0 }, "stars": { "title": "Rating filter", "enum": [ "", "5", "4", "3", "2", "1" ], "type": "string", "description": "Only return reviews with this star rating. Leave on 'All ratings' to collect every rating.", "default": "" }, "datePosted": { "title": "Date posted", "enum": [ "", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Only return reviews posted within this time period.", "default": "" }, "language": { "title": "Language", "enum": [ "", "en", "de", "fr", "es", "it", "nl", "pt", "da", "sv", "nb", "fi", "pl", "ru", "tr", "ar", "ja", "zh" ], "type": "string", "description": "Only return reviews written in this language. Select 'All languages' to collect reviews in every language.", "default": "" }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time in seconds to wait for each HTTP request before giving up.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to use for requests. Residential proxies (default) avoid bot detection and provide the best geographical coverage. Datacenter proxies are faster but more likely to be blocked." } } }, "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 } } } } } } } } } }