{ "openapi": "3.0.1", "info": { "title": "Review Radar: G2 + Capterra SaaS Reviews & AI Battlecards", "description": "Scrape SaaS product reviews from G2 and Capterra into normalized records (rating, pros/cons, reviewer firmographics). Optional AI battlecards for competitor analysis: strengths, weaknesses, top complaints, and switching reasons.", "version": "0.1", "x-build-id": "PJZhoQ6Ve5mWuDcXb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/outstanding_zinc~review-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-outstanding_zinc-review-radar", "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/outstanding_zinc~review-radar/runs": { "post": { "operationId": "runs-sync-outstanding_zinc-review-radar", "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/outstanding_zinc~review-radar/run-sync": { "post": { "operationId": "run-sync-outstanding_zinc-review-radar", "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": [ "productUrls" ], "properties": { "productUrls": { "title": "Product URLs or slugs", "type": "array", "description": "G2 and/or Capterra product review URLs, slugs, or names. G2: full URL, slug, or g2:slug. Capterra: full /p/// URL, id/slug, or capterra:Name (catalog resolves common SaaS names to the correct numeric id). Wrong id+slug combinations are corrected from the catalog or rejected with an error row — never wrong-product reviews.", "items": { "type": "string" } }, "maxReviews": { "title": "Max reviews per product", "minimum": 1, "type": "integer", "description": "Upper bound of review rows to keep per product after filters. Paginated; a few hundred is supported.", "default": 20 }, "publishedAfter": { "title": "Published on or after", "type": "string", "description": "ISO date or timestamp. Only keep reviews on/after this date. Leave empty for all." }, "publishedBefore": { "title": "Published on or before", "type": "string", "description": "ISO date or timestamp. Only keep reviews on/before this date. Leave empty for all." }, "starRatings": { "title": "Star rating filter", "type": "array", "description": "Only keep reviews in these 1–5 star buckets. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 Star", "2 Stars", "3 Stars", "4 Stars", "5 Stars" ] } }, "aiBattlecard": { "title": "Generate AI battlecard", "type": "boolean", "description": "When on, after scraping a product, call Apify OpenRouter to produce one battlecard row (strengths, weaknesses, top complaints, switching reasons, comparison notes). Off by default. Bills a separate PPE event when monetized.", "default": false }, "aiModel": { "title": "AI model (OpenRouter id)", "type": "string", "description": "Optional OpenRouter model id, e.g. openai/gpt-4o-mini. Used only when AI battlecard is on." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify Proxy group UNBLOCKER (required for reliable G2 + Capterra). Override groups only if you know what you are doing.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } }, "maxConcurrency": { "title": "Max concurrent products", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many products to scrape in parallel (1–5). Keep at 1–2 for challenge-prone sites.", "default": 1 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 15, "maximum": 180, "type": "integer", "description": "Per-request timeout in seconds for HTTP fetches (and Playwright if enabled).", "default": 60 }, "useBrowserFallback": { "title": "Playwright browser fallback", "type": "boolean", "description": "Off by default. When on, retries empty/blocked first pages with headless Chromium (slow, expensive, often fails through Unblocker CONNECT).", "default": false }, "debugProbeUrls": { "title": "Debug probe URLs (internal)", "type": "array", "description": "If set, Actor only fetches these URLs and stores PROBE_RESULTS then exits. For parser debugging.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }