{ "openapi": "3.0.1", "info": { "title": "Software ReviewsScraper — (G2, Capterra, TrustRadius)", "description": "Multi-platform B2B software reviews scraper with unified output across G2, Capterra, TrustRadius, SoftwareAdvice, GetApp. Auto platform detection. MCP-ready.", "version": "1.0", "x-build-id": "7AWFfb5cnYiioTbAY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~software-reviews-all-in-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-software-reviews-all-in-one-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/khadinakbar~software-reviews-all-in-one-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-software-reviews-all-in-one-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/khadinakbar~software-reviews-all-in-one-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-software-reviews-all-in-one-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", "properties": { "startUrls": { "title": "Product/reviews URLs", "type": "array", "description": "List of product or reviews URLs from G2, Capterra, TrustRadius, SoftwareAdvice, or GetApp. Platform is auto-detected from the domain. Example: 'https://www.g2.com/products/salesforce-sales-cloud/reviews'. Use this when you already know the product page. NOT a search term — use 'searchQuery' for that.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQuery": { "title": "Product name to search", "type": "string", "description": "Free-text software product name to find across platforms (e.g., 'Slack', 'HubSpot CRM', 'Notion'). Returns matching products from each enabled platform. Defaults to empty. NOT a URL — use 'startUrls' for direct product pages." }, "platforms": { "title": "Platforms to search", "uniqueItems": true, "type": "array", "description": "Platforms used in search mode (ignored for startUrls — URL auto-detects). Defaults to G2, Capterra, TrustRadius. Add 'softwareadvice' or 'getapp' for the Gartner-family discovery sites. NOT used when startUrls is provided.", "items": { "type": "string", "enum": [ "g2", "capterra", "trustradius", "softwareadvice", "getapp" ], "enumTitles": [ "G2", "Capterra", "TrustRadius", "SoftwareAdvice", "GetApp" ] }, "default": [ "g2", "capterra", "trustradius" ] }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on reviews scraped per product (across all pages). Lower this to control PPE spend. Default 100. Range 1-5000. NOT total reviews across products — set this per-product.", "default": 100 }, "maxProductsPerSearch": { "title": "Max products per search query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on products returned by each search per platform. Defaults to 10. Range 1-100. Only used in search mode.", "default": 10 }, "includeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "If true (default), scrapes individual reviews. If false, returns product summary cards only (name, rating, review count, URL) — cheaper for product discovery without review content. NOT a content filter — use 'maxReviewsPerProduct' to limit volume.", "default": true }, "sortReviewsBy": { "title": "Sort reviews by", "enum": [ "newest", "helpful" ], "type": "string", "description": "Review sort order. 'newest' returns most recent first, 'helpful' returns highest-voted first. Default 'newest'. NOT a filter — all matching reviews returned regardless of sort.", "default": "newest" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy. Residential is strongly recommended — G2 and Capterra use Cloudflare/Gartner anti-bot that blocks datacenter IPs. Default: residential US.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "debug": { "title": "Debug dump (developer only)", "type": "boolean", "description": "When true, the first page of each product is dumped to the run's key-value store under 'DEBUG--' for selector diagnostics. Leave OFF for production scrapes — it makes runs slower and clutters KV.", "default": false } } }, "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 } } } } } } } } } }