{ "openapi": "3.0.1", "info": { "title": "Trustpilot & Capterra Reviews Scraper: One Schema", "description": "Trustpilot and Capterra reviews in one table: rating, title, text, pros and cons, date, language, reviewer name and country, verified flag, company reply. Star, date and language filters, past the 200-review limit, new-reviews-only mode. Free status row per target.", "version": "0.1", "x-build-id": "j048mrsCUYo4JA7nu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dottti~business-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dottti-business-reviews", "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/dottti~business-reviews/runs": { "post": { "operationId": "runs-sync-dottti-business-reviews", "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/dottti~business-reviews/run-sync": { "post": { "operationId": "run-sync-dottti-business-reviews", "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": { "targets": { "title": "Companies or products", "type": "array", "description": "One per line. Trustpilot company page URL (https://www.trustpilot.com/review/careem.com), a bare domain (careem.com), a company name to look up on Trustpilot (Careem), or a Capterra product URL (https://www.capterra.com/p/135003/Slack/reviews/). G2 URLs are accepted but return a free 'not_supported' status row (see README).", "default": [ "careem.com" ], "items": { "type": "string" } }, "maxReviewsPerTarget": { "title": "Max reviews per target", "minimum": 1, "maximum": 100000, "type": "integer", "description": "You pay only for reviews delivered. Trustpilot: above 200, the actor splits the reviews by star rating and language to go past the 10-page limit for logged-out visitors.", "default": 20 }, "stars": { "title": "Star ratings", "type": "array", "description": "Only reviews with these ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "dateFrom": { "title": "Reviews published on or after", "type": "string", "description": "YYYY-MM-DD, or relative like '30 days' or '6 months'. Leave empty for no date limit.", "default": "" }, "language": { "title": "Review language", "type": "string", "description": "'all', or a 2-letter code such as en, ar, de, fr. Trustpilot filters on its own language tag. Capterra reviews are matched with a simple built-in language check.", "default": "all" }, "sort": { "title": "Order (Trustpilot)", "enum": [ "recency", "relevance" ], "type": "string", "description": "Newest first, or Trustpilot's 'most relevant' order. Capterra pages always come in Capterra's 'most helpful' order.", "default": "recency" }, "includeCompanyProfile": { "title": "Add a company profile row", "type": "boolean", "description": "One free row per target: overall rating, review count, star distribution, categories, country and reply behaviour (Trustpilot) or sub-ratings (Capterra).", "default": true }, "onlyNew": { "title": "Only new reviews since the last run", "type": "boolean", "description": "For scheduled alerts. Each run remembers the reviews it delivered, by target, under the state name below. The first run is the baseline and delivers up to the max.", "default": false }, "stateName": { "title": "State name", "type": "string", "description": "Separate names keep separate memories, for example 'brand-a' and 'competitors'.", "default": "default" }, "deepPagination": { "title": "Go past the 200-review limit (Trustpilot)", "type": "boolean", "description": "Splits the request by star rating, then by language, when more than 200 reviews are needed. Turn off to read only the first 10 pages.", "default": true }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Leave off to use the automatic fallback below. If you set a proxy here, it is used for every request and the fallback is off." }, "autoProxyFallback": { "title": "Automatic proxy fallback", "type": "boolean", "description": "Starts without a proxy. If a site keeps refusing, switches to Apify datacenter proxy, then residential.", "default": true }, "allowResidentialFallback": { "title": "Allow residential proxy as the last step", "type": "boolean", "description": "Turn off to never use residential proxy.", "default": true }, "useBrowserCheck": { "title": "Pass Trustpilot's automatic browser check", "type": "boolean", "description": "When Trustpilot shows its 'Verifying your connection' page, open it once in a headless browser so the site sets its normal cookie, then continue over plain HTTP. Captchas are never solved.", "default": true }, "maxConcurrency": { "title": "Targets in parallel", "minimum": 1, "maximum": 6, "type": "integer", "description": "Requests to each site are still spaced out.", "default": 3 }, "maxRetries": { "title": "Retries per page", "minimum": 1, "maximum": 10, "type": "integer", "description": "Retries with growing waits, fresh sessions and the next proxy tier before a target is marked blocked.", "default": 4 } } }, "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 } } } } } } } } } }