{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper", "version": "0.1", "x-build-id": "ozP2Q2N4QX9uoKD1D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smart_albatross~trustpilot-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smart_albatross-trustpilot-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/smart_albatross~trustpilot-reviews-scraper/runs": { "post": { "operationId": "runs-sync-smart_albatross-trustpilot-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/smart_albatross~trustpilot-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-smart_albatross-trustpilot-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Companies", "type": "array", "description": "Company domains (nordvpn.com) or Trustpilot review URLs (https://www.trustpilot.com/review/nordvpn.com). Filters in a pasted URL (?stars=1&languages=de) are applied to that company.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per company. 0 = collect as many as Trustpilot exposes (goes far past the 200-review web limit); with Newest first they are delivered newest first once collection finishes.", "default": 1000 }, "sort": { "title": "Order", "enum": [ "recency", "relevance" ], "type": "string", "description": "Newest first returns the most recent reviews in date order, also beyond 200 (exact down to the company row's completeSince, best effort before it). Most relevant uses Trustpilot's relevance order, which only exists for the first 200 per filter; beyond that rows are collected for coverage, unordered.", "default": "recency" }, "deepHistory": { "title": "Deep history (maximum coverage, unordered)", "type": "boolean", "description": "Collect as much of a company's history as possible by slicing on language, stars, replies and keywords. Rows stream in as found and are not in date order. Best for full exports with max reviews 0.", "default": false }, "stars": { "title": "Star ratings", "type": "array", "description": "Only reviews with these star ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "languages": { "title": "Review languages", "type": "array", "description": "ISO language codes (en, de, fr...). Default: all languages. Trustpilot's own page shows only English unless told otherwise.", "default": [ "all" ], "items": { "type": "string" } }, "datePreset": { "title": "Published within", "enum": [ "all", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Only reviews published in this period.", "default": "all" }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Only reviews Trustpilot marks as verified.", "default": false }, "withRepliesOnly": { "title": "Only reviews with a company reply", "type": "boolean", "description": "Only reviews the company has replied to.", "default": false }, "keyword": { "title": "Keyword", "type": "string", "description": "Trustpilot's review search. Words separated by spaces match any word; put a phrase in quotes to match it exactly." }, "reviewsNewerThan": { "title": "Only reviews newer than", "type": "string", "description": "Monitoring mode: collect only reviews published on or after this date. Ideal for scheduled daily or weekly syncs." }, "includeCompanyProfile": { "title": "Company profile row", "type": "boolean", "description": "Add one row per company with TrustScore, star histogram, language breakdown, categories, contact details, reply behaviour and coverage.", "default": true }, "maxRequestsPerCompany": { "title": "Max requests per company", "minimum": 0, "type": "integer", "description": "Safety limit on requests per company. 0 = automatic (scales with the company's review count).", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy works well. Residential is used automatically as a fallback when datacenter IPs are blocked.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }