{ "openapi": "3.0.1", "info": { "title": "Trustpilot Plus", "description": "No limits and lots of filters! Get reviews and sentiment (Negative, Neutral, Positive) from Trustpilot. It's fast, costs little and supports all countries.", "version": "2.0", "x-build-id": "LvuppuBL2XdUSEZYP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/canadesk~trustpilot-plus/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-canadesk-trustpilot-plus", "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/canadesk~trustpilot-plus/runs": { "post": { "operationId": "runs-sync-canadesk-trustpilot-plus", "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/canadesk~trustpilot-plus/run-sync": { "post": { "operationId": "run-sync-canadesk-trustpilot-plus", "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": [ "website" ], "properties": { "website": { "title": "Websites", "type": "array", "description": "Website(s) to fetch reviews for - NOT the Trustpilot link.", "items": { "type": "string" } }, "country": { "title": "Default country", "enum": [ "us", "ca", "dk", "at", "ch", "de", "au", "uk", "ie", "nz", "es", "fi", "fr", "it", "jp", "no", "nl", "pl", "bt", "pt", "se" ], "type": "string", "description": "Default country for Trustpilot.", "default": "us" }, "process": { "title": "Process", "enum": [ "ga", "gas" ], "type": "string", "description": "See Information tab.", "default": "gas" }, "sort": { "title": "Sort by", "enum": [ "recency", "relevance" ], "type": "string", "description": "", "default": "recency" }, "daterange": { "title": "Filter - Date posted", "enum": [ "all", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Filter for date range.", "default": "last6months" }, "keywords": { "title": "Filter - Search terms", "maxLength": 100, "type": "string", "description": "Filter to search for specific keywords." }, "stars": { "title": "Filter - Stars", "enum": [ "1", "2", "3", "4", "5", "all" ], "type": "string", "description": "Filter for ratings.", "default": "all" }, "language": { "title": "Filter - Language", "enum": [ "all", "af", "ak", "ar", "ar-latn", "bg", "bg-latn", "bn", "bs", "ca", "cs", "da", "de", "el", "en", "es", "et", "fa", "fi", "fil", "fr", "fy", "ga", "gl", "haw", "hi", "ht", "hu", "id", "it", "ja", "ko", "la", "lt", "mg", "mn", "nl", "no", "oc", "pa", "pl", "pt", "ro", "ru", "sl", "so", "sr", "sv", "sw", "th", "ti", "tl", "tr", "uk", "und", "ur", "uz", "vi", "war", "xh", "zh", "zu" ], "type": "string", "description": "Filter for review languages.", "default": "en" }, "replies": { "title": "Filter - Replies", "enum": [ "only", "all" ], "type": "string", "description": "Filter for reviews with repies from the business.", "default": "all" }, "verified": { "title": "Filter - Verified", "enum": [ "only", "all" ], "type": "string", "description": "Filter for reviews verified by Trustpilot.", "default": "all" }, "format": { "title": "Save on usage costs", "enum": [ "list", "wrap" ], "type": "string", "description": "See Information tab.", "default": "wrap" }, "maximum": { "title": "Maximum results", "minimum": 20, "type": "integer", "description": "Per website. Maximum number of records returned (impact on performance).", "default": 40 }, "batch": { "title": "Parallel processing", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only relevant for Get All Reviews. See Information tab.", "default": 1 }, "delay": { "title": "Delay", "minimum": 1, "maximum": 30, "type": "integer", "description": "Waiting time between requests.", "default": 2 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "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 } } } } } } } } } }