{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper", "description": "Paste companies and get their Trustpilot reviews in every language, past the 200-review limit, with star, language, date and country filters, a stats row per company and a report of exactly what was collected.", "version": "0.1", "x-build-id": "OCwynb1K8gBREi3Fk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alkausari_mujahid~trustpilot-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alkausari_mujahid-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/alkausari_mujahid~trustpilot-reviews-scraper/runs": { "post": { "operationId": "runs-sync-alkausari_mujahid-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/alkausari_mujahid~trustpilot-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-alkausari_mujahid-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": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "One per line: a website domain (amazon.com), a Trustpilot page (https://www.trustpilot.com/review/www.amazon.com) or a brand name (Nike). Brand names are looked up on Trustpilot's search; the report shows which company was picked and the other matches.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Maximum reviews per company", "minimum": 0, "type": "integer", "description": "The newest reviews are kept first. 0 = every review Trustpilot shows publicly. In Monitor mode: how many of each company's most recent reviews are checked per run — keep it above the number of reviews a company gets between runs, or 0.", "default": 0 }, "mode": { "title": "What do you need?", "enum": [ "full", "monitor", "negative", "compare" ], "type": "string", "description": "A starting point — the filters below can refine any of them.", "default": "full" }, "stars": { "title": "Star ratings", "type": "array", "description": "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" ] } }, "languages": { "title": "Review languages", "type": "array", "description": "Only reviews written in these languages, as 2-letter codes (en, de, fr, es, it, nl, da…). Leave empty for all languages.", "items": { "type": "string" } }, "reviewerCountries": { "title": "Reviewer countries", "type": "array", "description": "Only reviews by people from these countries, as 2-letter codes (US, GB, DE…). Leave empty for all countries.", "items": { "type": "string" } }, "datePreset": { "title": "Published within", "enum": [ "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Only reviews published in this period. Leave empty for any time." }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Only reviews published on or after this date — an exact date or a period back from today (e.g. 14 days)." }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Only reviews Trustpilot labels as Verified.", "default": false }, "repliesOnly": { "title": "Only reviews the company replied to", "type": "boolean", "description": "Only reviews with a reply from the company.", "default": false }, "includeCompanyDetails": { "title": "Add a row per company", "type": "boolean", "description": "A Companies table with one row per company: TrustScore, total reviews, star and language breakdown, categories, contact details and how often it replies to negative reviews.", "default": true }, "changeWindowDays": { "title": "Days to re-check for changes", "minimum": 0, "maximum": 365, "type": "integer", "description": "Reviews published in the last this-many days are compared with the previous run, to catch edited reviews, new company replies and deleted reviews. The first run returns these days as its starting point. 0 = only look for new reviews (cheapest).", "default": 30 }, "memoryName": { "title": "Memory name", "type": "string", "description": "Monitor mode remembers each company's reviews in a key-value store of this name in your account (letters, digits and hyphens). Leave empty for one memory per saved task. Use a new name to start over." }, "maxConcurrency": { "title": "Parallel sessions", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many browser sessions read Trustpilot at the same time. Each uses its own proxy IP and reads about one page (20 reviews) per second.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy datacenter IPs work well. Each parallel session gets its own IP.", "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 } } } } } } } } } }