{ "openapi": "3.0.1", "info": { "title": "Competitor Review Intelligence – G2, Trustpilot & Capterra", "description": "Scrapes G2, Trustpilot, and Capterra reviews and applies AI aspect-based sentiment analysis, classifying feedback by pricing, UX, support, integrations, and performance. Detects churn signals and competitor-switching intent at $0.015 per classified review.", "version": "1.0", "x-build-id": "f9bvLv2E0e961PduP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/conceivable_extension~competitor-review-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-conceivable_extension-competitor-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/conceivable_extension~competitor-review-intelligence/runs": { "post": { "operationId": "runs-sync-conceivable_extension-competitor-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/conceivable_extension~competitor-review-intelligence/run-sync": { "post": { "operationId": "run-sync-conceivable_extension-competitor-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", "properties": { "products": { "title": "Products to Analyse", "type": "array", "description": "Product profile URLs or names to scrape reviews for. Each entry can include g2Url, trustpilotUrl, and/or capterraUrl.", "default": [ { "name": "Competitor Product", "g2Url": "https://www.g2.com/products/competitor/reviews", "trustpilotUrl": "https://www.trustpilot.com/review/competitor.com", "capterraUrl": "https://www.capterra.com/p/123456/competitor/" } ] }, "platforms": { "title": "Review Platforms", "type": "array", "description": "Which review platforms to scrape. Valid values: g2, trustpilot, capterra, bol_com. `sources` (below) is an alias for this field using the addendum's own naming — either works, `sources` takes precedence if both are set.", "default": [ "g2", "trustpilot" ] }, "sources": { "title": "Sources (alias for Platforms)", "type": "array", "description": "Alias for `platforms`, matching the addendum's own field name. Include \"bol_com\" here (and configure bolComConfig below) to enable Bol.com." }, "bolComConfig": { "title": "Bol.com Config", "type": "object", "description": "Required to scrape Bol.com. { productUrls: string[], searchKeyword: string, maxReviewsPerProduct: number }. Either productUrls or searchKeyword (or both) can be set — searchKeyword pulls real product URLs from a live Bol.com search first. KNOWN LIMITATION (see README): Bol.com's real Akamai TLS-fingerprint bot protection currently blocks every proxy option available on this Apify account (tried live: RESIDENTIAL group and automatic/default selection, both 403). The extraction logic is real and correct but cannot currently reach live Bol.com pages — see README for full details and what would unblock this." }, "maxReviewsPerProduct": { "title": "Max Reviews Per Product", "minimum": 10, "maximum": 500, "type": "integer", "description": "Maximum number of reviews to collect per product per platform.", "default": 100 }, "classifyAspects": { "title": "AI Aspect Classification", "type": "boolean", "description": "Use GPT-4o-mini to extract which specific features each review praises or complains about.", "default": true }, "openaiApiKey": { "title": "OpenAI API Key", "type": "string", "description": "Required when AI Aspect Classification is enabled. Your OpenAI API key for GPT-4o-mini calls." }, "detectChurnSignals": { "title": "Detect Competitor-Switch Signals", "type": "boolean", "description": "Flag reviews that mention switching to a competitor or cancelling due to specific issues.", "default": true }, "filterMinRating": { "title": "Minimum Star Rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only process reviews at or above this star rating (1–5). Set to 1 to include all.", "default": 1 }, "filterMaxRating": { "title": "Maximum Star Rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only process reviews at or below this star rating (1–5). Set to 5 to include all.", "default": 5 } } }, "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 } } } } } } } } } }