{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper & New Review Monitor", "description": "Scrape Trustpilot reviews for many brands in one run and get only reviews that are new since the last run. Filter 1-2 star or unanswered reviews. Review text, rating, date, author country, company reply status.", "version": "1.0", "x-build-id": "gY3c6Ta5xrhxGAa3b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ivora~trustpilot-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ivora-trustpilot-review-monitor", "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/ivora~trustpilot-review-monitor/runs": { "post": { "operationId": "runs-sync-ivora-trustpilot-review-monitor", "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/ivora~trustpilot-review-monitor/run-sync": { "post": { "operationId": "run-sync-ivora-trustpilot-review-monitor", "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": [ "brands" ], "properties": { "brands": { "title": "Brands", "type": "array", "description": "Company domains as they appear on Trustpilot (allbirds.com, www.amazon.com) or Trustpilot page URLs (https://www.trustpilot.com/review/allbirds.com). Add all your clients here: one run checks them all.", "default": [ "allbirds.com", "www.gymshark.com" ], "items": { "type": "string" } }, "maxRating": { "title": "Alert on ratings up to", "minimum": 1, "maximum": 5, "type": "integer", "description": "5 = every new review. 2 = only new 1-2 star reviews (negative). 3 = 1-3 stars. The rating filter is applied on Trustpilot's side, so it is also cheaper for busy brands.", "default": 5 }, "onlyUnanswered": { "title": "Only reviews without a company reply", "type": "boolean", "description": "Skip new reviews that the company has already answered.", "default": false }, "firstRunBehavior": { "title": "First run of a monitor", "enum": [ "baseline", "outputRecent" ], "type": "string", "description": "On the first run there is nothing to compare with. baseline = remember the current reviews and output nothing but a summary. outputRecent = also output up to 'First-run rows limit' latest reviews per brand.", "default": "baseline" }, "firstRunRowsLimit": { "title": "First-run rows limit per brand", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many of the latest reviews to output per brand on the first run when 'Output the latest reviews' is selected (max 20).", "default": 10 }, "maxPagesPerBrand": { "title": "Max pages per brand", "minimum": 1, "maximum": 50, "type": "integer", "description": "Safety cap. One page = 20 reviews. 5 pages = up to 100 new reviews per brand between two runs. Raise it for very busy brands or run more often.", "default": 5 }, "stateStoreName": { "title": "Monitor name (state store)", "type": "string", "description": "Named key-value store that remembers which reviews you have already seen. Use a different name for each separate monitor (e.g. one per client group). Only a-z, 0-9 and '-'.", "default": "trustpilot-review-monitor-state" }, "includeSummary": { "title": "Summary row per brand", "type": "boolean", "description": "Free row per brand with TrustScore, total reviews and counts of new / negative / unanswered reviews.", "default": true }, "residentialFallback": { "title": "Automatic residential proxy fallback", "type": "boolean", "description": "If Trustpilot blocks the request, retry through Apify residential proxy (paid by the developer, not by you).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed normally.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Parallel brands", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many brands are checked at the same time.", "default": 3 } } }, "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 } } } } } } } } } }