{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper - Filters & Monitoring", "description": "Scrape Trustpilot reviews, ratings, replies, verification, reviewer metadata, and company TrustScores with star, date, language, country, and monitoring filters.", "version": "2.0", "x-build-id": "agh4gM43OifGcwRAv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~trustpilot-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-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/thirdwatch~trustpilot-reviews-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-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/thirdwatch~trustpilot-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-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", "properties": { "companyUrls": { "title": "Company domains or URLs", "type": "array", "description": "Up to 20 bare domains, company website URLs, or Trustpilot /review/ URLs. This field remains compatible with existing integrations.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional Request List of company website or Trustpilot review URLs. You can combine this with companyUrls.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviewsPerCompany": { "title": "Maximum reviews per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum matching reviews returned for each company. The Actor keeps paginating when filters exclude rows.", "default": 50 }, "ratings": { "title": "Star ratings", "uniqueItems": true, "type": "array", "description": "Return only reviews with these ratings. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "languages": { "title": "Review languages", "type": "array", "description": "Optional ISO 639-1 language codes such as en, de, fr, or es.", "default": [], "items": { "type": "string" } }, "reviewerCountries": { "title": "Reviewer countries", "type": "array", "description": "Optional ISO 3166-1 alpha-2 country codes such as US, GB, or DE.", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "recency", "relevance" ], "type": "string", "description": "Most recent is best for monitoring. Relevance prioritizes detailed reviews.", "default": "recency" }, "dateRange": { "title": "Published date range", "enum": [ "all", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Limit reviews to a rolling publication window. Leave All time for no rolling cutoff.", "default": "all" }, "startDate": { "title": "Published on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional exact ISO date such as 2026-07-01. This overrides the rolling date range for client-side validation." }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Return only reviews Trustpilot marks as verified.", "default": false }, "repliesOnly": { "title": "Reviews with company replies only", "type": "boolean", "description": "Return only reviews that contain a public company response.", "default": false }, "monitoringMode": { "title": "Return only new reviews", "type": "boolean", "description": "Persist review IDs in a named key-value store. The first run creates the baseline; later identical runs return only unseen reviews.", "default": false }, "monitoringKey": { "title": "Monitoring key", "maxLength": 48, "type": "string", "description": "Optional stable name for a monitor shared across saved tasks or schedules. Otherwise the Actor derives one from companies and filters." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is required to establish the public Trustpilot browser session. Pagination then reuses that session through fast HTTP fetches.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }