{ "openapi": "3.0.1", "info": { "title": "Multi-Review Scraper — Trustpilot & BBB in One Run", "description": "Multi Review Scraper. Available on the Apify Store with pay-per-event pricing.", "version": "2.0", "x-build-id": "bkrIfjbbnEw4FK2af" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~multi-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-multi-review-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/ryanclinton~multi-review-scraper/runs": { "post": { "operationId": "runs-sync-ryanclinton-multi-review-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/ryanclinton~multi-review-scraper/run-sync": { "post": { "operationId": "run-sync-ryanclinton-multi-review-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": [ "businessName" ], "properties": { "businessName": { "title": "Business Name", "type": "string", "description": "Name of the business to search for reviews (e.g. Stripe, Shopify)", "default": "Stripe" }, "businessDomain": { "title": "Business Domain", "type": "string", "description": "Business website domain for more accurate matching on Trustpilot (e.g. stripe.com)" }, "competitors": { "title": "Competitors (benchmark cohort)", "maxItems": 10, "type": "array", "description": "Optional. Names or domains of competitors to analyse alongside the primary business. The actor scores each and emits a 'benchmark' record ranking them. Ranking is relative to the businesses you supply here, not an industry-wide baseline. Each competitor is charged as a separate business analysed.", "items": { "type": "string" } }, "industry": { "title": "Industry", "enum": [ "generic", "saas", "ecommerce", "hosting", "telecom", "logistics", "finance" ], "type": "string", "description": "Optional. Tells the actor which reputation pillars matter most for this business's sector (e.g. ecommerce prioritises delivery + billing; SaaS prioritises product quality + support). A lens for prioritising weak areas — it does not change the core reputation score.", "default": "generic" }, "analysisType": { "title": "Analysis Type", "enum": [ "general", "vendor-screening", "lead-qualification", "competitive-analysis", "reputation-monitoring", "investment-due-diligence" ], "type": "string", "description": "The job you're doing. 'vendor-screening' and 'investment-due-diligence' weight trustworthiness heavily in the procurement tier (green/yellow/red/blacklist). 'lead-qualification' and 'competitive-analysis' weight reputation. 'reputation-monitoring' is for scheduled tracking (pair with a watchlist name). Same scraping — different decision emphasis.", "default": "general" }, "platforms": { "title": "Platforms", "maxItems": 2, "type": "array", "description": "Which review platforms to scrape. Options: trustpilot, bbb. Defaults to both when left empty.", "items": { "type": "string" } }, "maxReviewsPerPlatform": { "title": "Max Reviews Per Platform", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of reviews to scrape from each platform", "default": 20 }, "minRating": { "title": "Minimum Rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only return reviews at or above this star rating (1-5). Leave empty for all reviews." }, "outputProfile": { "title": "Output Profile", "enum": [ "minimal", "standard", "full" ], "type": "string", "description": "How much detail to return. 'minimal' = decision fields only (recommendation, reputation score, risk). 'standard' = full reviews + reputation decision. 'full' = everything including scoring components and per-review internals.", "default": "standard" }, "watchlistName": { "title": "Watchlist Name (reputation tracking)", "type": "string", "description": "Optional. Set a name to track this business's reputation across scheduled runs. The actor stores each run's reputation score under this watchlist and reports the trend (improving / declining / stable) on the next run. Leave empty for one-off analysis." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Defaults to Apify residential proxy for reliable results." } } }, "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 } } } } } } } } } }