{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper + AI Analysis", "description": "Scrape Trustpilot business profiles and reviews, then optionally enrich them with AI sentiment, themes, complaints, praises and fake-review detection.", "version": "0.1", "x-build-id": "WuC6px5JNXgsYMpHL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lizzyyy2~trustpilot-reviews-scraper-ai/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lizzyyy2-trustpilot-reviews-scraper-ai", "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/lizzyyy2~trustpilot-reviews-scraper-ai/runs": { "post": { "operationId": "runs-sync-lizzyyy2-trustpilot-reviews-scraper-ai", "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/lizzyyy2~trustpilot-reviews-scraper-ai/run-sync": { "post": { "operationId": "run-sync-lizzyyy2-trustpilot-reviews-scraper-ai", "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 URLs / domains", "type": "array", "description": "Trustpilot review URLs (e.g. https://www.trustpilot.com/review/amazon.com) or bare company domains (e.g. amazon.com). Both work.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to find companies on Trustpilot (e.g. \"web hosting\", \"car insurance\"). Each term returns the matching businesses.", "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies (total)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on how many companies to scrape across all URLs and search terms.", "default": 10 }, "maxCompaniesPerSearch": { "title": "Max companies per search term", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many companies to take from each search term.", "default": 10 }, "includeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "Fetch the review list for each company. Turn off for a company-profile-only scrape.", "default": true }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Newest/most-relevant reviews per company. Trustpilot serves 20 reviews per page.", "default": 100 }, "reviewSort": { "title": "Review sort order", "enum": [ "recency", "relevance" ], "type": "string", "description": "How to order reviews before taking the cap.", "default": "recency" }, "reviewLanguage": { "title": "Review language", "enum": [ "all", "en", "de", "fr", "es", "it", "nl", "da", "sv", "no", "fi", "pt" ], "type": "string", "description": "Language of reviews to fetch. \"all\" returns every language.", "default": "all" }, "starRatings": { "title": "Star ratings filter", "type": "array", "description": "Only keep reviews with these star 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": [] }, "aiEnrichment": { "title": "Enable AI insights", "type": "boolean", "description": "Master switch for the AI features below. AI is billed per insight (pay-per-event), so a plain scrape stays cheap.", "default": false }, "aiCompanyInsights": { "title": "AI company insights", "type": "boolean", "description": "A reputation summary, the top recurring complaints and the top praises for each company, mined from its reviews.", "default": false }, "aiReviewAnalysis": { "title": "AI review analysis", "type": "boolean", "description": "Per-review sentiment, theme tags and a one-line summary for recent reviews.", "default": false }, "aiFakeReviewDetection": { "title": "AI fake-review detection", "type": "boolean", "description": "Flags reviews that look fake/incentivised with a suspicion score and reasons.", "default": false }, "aiResponseSuggestions": { "title": "AI response suggestions", "type": "boolean", "description": "Drafts a professional reply a brand could post to recent negative reviews.", "default": false }, "aiLanguage": { "title": "AI output language", "type": "string", "description": "Language for the AI-generated text (summaries, suggestions, etc.).", "default": "English" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for all requests. Trustpilot is behind a WAF; the default Apify proxy is recommended.", "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 } } }, "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 } } } } } } } } } }