{ "openapi": "3.0.1", "info": { "title": "Trustpilot Business Reviews Scraper", "description": "Collect public Trustpilot business reviews from page URLs, company domains, or business keywords. Get review text, ratings, dates, reviewer context, and business reputation metrics, plus replies when available, in an Apify dataset.", "version": "0.0", "x-build-id": "qY7sfEYQz2VyO5Nd7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~trustpilot-business-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-trustpilot-business-reviews", "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/maximedupre~trustpilot-business-reviews/runs": { "post": { "operationId": "runs-sync-maximedupre-trustpilot-business-reviews", "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/maximedupre~trustpilot-business-reviews/run-sync": { "post": { "operationId": "run-sync-maximedupre-trustpilot-business-reviews", "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": [ "discoveryMethod" ], "properties": { "discoveryMethod": { "title": "Find reviews by", "enum": [ "trustpilotPages", "businessKeywords" ], "type": "string", "description": "Choose how to find the Trustpilot business pages to process." }, "companyUrls": { "title": "Company URLs", "minItems": 1, "maxItems": 200, "type": "array", "description": "Add one or more full URLs. Each URL can be a Trustpilot business review page or a company domain. Up to 200 company targets are supported. Use this field when Find reviews by is Trustpilot pages or domains.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "businessKeywords": { "title": "Business keywords", "minItems": 1, "type": "array", "description": "Add one or more ordinary business keywords or short phrases. The Actor uses them to find matching Trustpilot business pages. Use this field when Find reviews by is Business keywords.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 1, "type": "integer", "description": "Optional positive whole number of reviews to collect for each company. Leave empty to collect all available public reviews until the source is exhausted." }, "ratingFilter": { "title": "Star rating", "type": "object", "description": "Optionally filter reviews by stars. Set minimum and maximum to the same number for an exact rating, or use different numbers for a range. Leave both empty to include every rating.", "properties": { "minStars": { "title": "Minimum stars", "type": "integer", "description": "The lowest star rating to include, from 1 to 5.", "minimum": 1, "maximum": 5 }, "maxStars": { "title": "Maximum stars", "type": "integer", "description": "The highest star rating to include, from 1 to 5.", "minimum": 1, "maximum": 5 } } }, "languageCodes": { "title": "Review languages", "type": "array", "description": "Optionally include only reviews in the listed languages. Enter language codes such as en or de, or leave this field empty to include all available languages.", "items": { "type": "string" } }, "publishedFrom": { "title": "Published from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only include reviews published on or after this date. Use YYYY-MM-DD." }, "publishedTo": { "title": "Published to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only include reviews published on or before this date. Use YYYY-MM-DD." }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Turn on to include only reviews marked as verified. Leave off to include all reviews.", "default": false }, "repliedOnly": { "title": "Reviews with business replies only", "type": "boolean", "description": "Turn on to include only reviews with a public business reply. Leave off to include reviews with or without a reply.", "default": false }, "reviewKeyword": { "title": "Review keyword", "type": "string", "description": "Optionally include only reviews whose title or full text contains this keyword. Leave empty to include all reviews." }, "__concurrency": { "title": "Concurrency", "minimum": 1, "type": "integer", "description": "Internal optimization concurrency.", "default": 16 } } }, "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 } } } } } } } } } }