{ "openapi": "3.0.1", "info": { "title": "Trustpilot Company Reviews Scraper", "description": "Scrape Trustpilot company reviews by domain. Extract review text, ratings, reviewer names, dates, verification status, company replies, filters, and pagination metadata for reputation monitoring and competitor research.", "version": "1.0", "x-build-id": "vV5H3VZnFuoRzQe6I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrappa~trustpilot-company-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrappa-trustpilot-company-reviews-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/thescrappa~trustpilot-company-reviews-scraper/runs": { "post": { "operationId": "runs-sync-thescrappa-trustpilot-company-reviews-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/thescrappa~trustpilot-company-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-thescrappa-trustpilot-company-reviews-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": [ "company_domain" ], "properties": { "company_domain": { "title": "Company Domain", "type": "string", "description": "Company domain with or without protocol, for example amazon.com or https://www.amazon.com." }, "locale": { "title": "Locale", "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "description": "Trustpilot locale used for the review page.", "default": "en-US" }, "page": { "title": "Start Page", "minimum": 1, "maximum": 10, "type": "integer", "description": "First Trustpilot review page to fetch. Trustpilot limits public access to approximately the first 10 pages.", "default": 1 }, "max_pages": { "title": "Max Pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of pages to fetch in this run. Page plus Max Pages cannot go beyond page 10.", "default": 1 }, "per_page": { "title": "Reviews Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum reviews returned per page after Scrappa filtering.", "default": 20 }, "sort": { "title": "Sort", "enum": [ "recency", "relevance" ], "type": "string", "description": "Use recency for monitoring or relevance for representative samples.", "default": "recency" }, "rating": { "title": "Rating Filter", "type": "string", "description": "Comma-separated ratings from 1 to 5, for example 1,2 for negative-review monitoring or 4,5 for positive reviews." }, "verified": { "title": "Verified Only", "type": "boolean", "description": "Only return verified reviews." }, "with_replies": { "title": "With Company Replies Only", "type": "boolean", "description": "Only return reviews that include company replies." }, "query": { "title": "Search Within Reviews", "maxLength": 200, "type": "string", "description": "Keyword to search in review title or text, such as refund, delivery, support, or warranty." }, "date_posted": { "title": "Date Posted", "enum": [ "any", "last_30_days", "last_3_months", "last_6_months", "last_12_months" ], "type": "string", "description": "Limit reviews by publication date.", "default": "any" }, "fields": { "title": "Fields", "maxLength": 500, "type": "string", "description": "Optional comma-separated Scrappa response fields to include, such as reviews, relevantReviews, aiSummaryReviews, businessUnit.displayName, and pagination. Leave empty for the full response." } } }, "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 } } } } } } } } } }