{ "openapi": "3.0.1", "info": { "title": "Reviews Scraper & AI Insights — 5 Sources in One", "description": "All public reviews for a company or app across Trustpilot, G2, Capterra, the App Store and Google Play in one schema, with ratings, dates and company replies. Optional AI insights: themes, pain points, praise, feature requests and competitor mentions, in English or Arabic.", "version": "0.1", "x-build-id": "K3Uc5wvvTPMRklyRx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/almoutasem_nabil~review-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-almoutasem_nabil-review-intelligence", "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/almoutasem_nabil~review-intelligence/runs": { "post": { "operationId": "runs-sync-almoutasem_nabil-review-intelligence", "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/almoutasem_nabil~review-intelligence/run-sync": { "post": { "operationId": "run-sync-almoutasem_nabil-review-intelligence", "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": [ "targets" ], "properties": { "targets": { "title": "Companies or apps", "minItems": 1, "type": "array", "description": "Each entry is { name, website, trustpilotDomain, g2Url, capterraUrl, appStoreId, appStoreUrl, googlePlayId, googlePlayUrl }. Only 'name' is required — 'website' is enough for Trustpilot, and app ids are looked up from the name when omitted." }, "sources": { "title": "Sources", "type": "array", "description": "Which review sources to read. G2 and Capterra are off by default: both block automated traffic aggressively, so selecting them usually returns a source error rather than reviews.", "items": { "type": "string", "enum": [ "trustpilot", "g2", "capterra", "appstore", "googleplay" ] }, "default": [ "trustpilot", "appstore", "googleplay" ] }, "countries": { "title": "App store countries", "type": "array", "description": "Storefronts to read for the App Store and Google Play, as ISO-2 codes. Each storefront has its own reviews, so adding sa/ae/eg is how you get Gulf and Egyptian feedback.", "default": [ "us", "gb", "sa", "ae", "eg" ], "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "Keep only reviews in these languages (ISO-639-1, e.g. en, ar). Leave empty for all.", "items": { "type": "string" } }, "lastNDays": { "title": "Last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Ignore reviews older than this. Reviews with no date are kept, so a source that omits dates is not silently dropped.", "default": 90 }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews at or above this rating, on the normalized 1-5 scale." }, "maxRating": { "title": "Maximum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews at or below this rating. Set to 2 to collect complaints only." }, "maxReviewsPerSource": { "title": "Max reviews per source", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many reviews per target per source. This is the main control on cost.", "default": 200 }, "includeCompanyReplies": { "title": "Include company replies", "type": "boolean", "description": "Include the company's public reply to a review where the source publishes one.", "default": true }, "aiInsights": { "title": "AI insights", "type": "boolean", "description": "Turn the collected reviews into themes, pain points, praise, feature requests, competitor mentions and suggested actions. Billed per batch of 10 reviews analyzed.", "default": false }, "insightsLanguage": { "title": "Insights language", "enum": [ "en", "ar" ], "type": "string", "description": "Language for the AI insights. 'ar' produces Modern Standard Arabic; review quotes stay in the language they were written in.", "default": "en" }, "emitChangesOnly": { "title": "Emit alerts only", "type": "boolean", "description": "Return only what is new since the last run under the same tracking ID: new reviews, negative reviews, rating drops and newly added company replies. Off = return the reviews themselves.", "default": false }, "trackingId": { "title": "Tracking ID", "type": "string", "description": "Name of this watch. Required when 'Emit alerts only' is on. Snapshots are stored under this key in the 'review-intel-state' key-value store." }, "emitBaselineAsNew": { "title": "Report the first run", "type": "boolean", "description": "On the first run for a tracking ID, report every review as new. Off = the first run records a baseline silently so your first alert is a real one.", "default": false }, "negativeAlertMaxRating": { "title": "Negative review threshold", "minimum": 1, "maximum": 5, "type": "integer", "description": "A new review at or below this rating also raises a separate negative_review alert — the one you route to a human.", "default": 2 }, "ratingDropThreshold": { "title": "Rating drop threshold", "minimum": 0, "maximum": 5, "type": "number", "description": "Raise a rating_drop alert when a source's average rating falls by at least this much since the last run.", "default": 0.3 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many target x source pairs are fetched in parallel.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxies for the requests. Datacenter is enough for the App Store and Google Play; Trustpilot often needs residential.", "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 } } } } } } } } } }