{ "openapi": "3.0.1", "info": { "title": "Software Reviews: Capterra, GetApp, G2", "description": "Software reviews from the review pool Capterra, GetApp and Software Advice share, by product or category, filtered by star rating and date and checked against the site's own count; plus G2's newest reviews.", "version": "0.1", "x-build-id": "bFGLjkh0ayD61jgaG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vonsensey~software-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vonsensey-software-reviews-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/vonsensey~software-reviews-scraper/runs": { "post": { "operationId": "runs-sync-vonsensey-software-reviews-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/vonsensey~software-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-vonsensey-software-reviews-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": { "products": { "title": "Products", "type": "array", "description": "Capterra product URLs (e.g. https://www.capterra.com/p/135003/Slack/): the reviews Capterra, GetApp and Software Advice share, once. G2 product URLs (e.g. https://www.g2.com/products/slack/reviews): G2's newest reviews. A GetApp or Software Advice URL: give the product's Capterra URL instead (the same reviews).", "default": [], "items": { "type": "string" } }, "categories": { "title": "Capterra categories", "type": "array", "description": "Capterra category URLs, e.g. https://www.capterra.com/team-communication-software/. The listed products are read in the site's order, up to the per-category limit.", "default": [], "items": { "type": "string" } }, "maxProductsPerCategory": { "title": "Products per category", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most products read from each category.", "default": 20 }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only reviews with these star ratings. Empty reads every rating. Capterra: each star is read separately and checked against the site's count for that star. G2: its feed has no filter, so the star is applied here (a half star counts to the star below: 4.5 is 4).", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "since": { "title": "Reviews since", "type": "string", "description": "Only reviews written on or after this day (YYYY-MM-DD)." }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most reviews read per product (per star when stars are selected). With 'Only new' on, reviews an earlier run read do not count. Each run starts from the newest review: reviews past the cap that a run did not read are not read later (raise the cap to read further back).", "default": 100 }, "maxReviewsTotal": { "title": "Reviews in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "The run stops once this many reviews are delivered.", "default": 1000 }, "includeProfiles": { "title": "Product profiles", "type": "boolean", "description": "One row per Capterra product: rating, review count and the four sub-ratings.", "default": true }, "personalData": { "title": "Reviewer names and job titles", "type": "boolean", "description": "Include the reviewer's name, job title and LinkedIn verification. Off by default; company size, industry and time used are always included.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new reviews since the last run", "type": "boolean", "description": "Remember how far this feed has read each product and star; the next run delivers only what is new, plus any part an interrupted run left unread. If the memory cannot be read, the run stops with a free row instead of re-sending old reviews.", "default": false }, "stateName": { "title": "Feed name", "type": "string", "description": "Separate memory per feed when 'Only new' is on." }, "maxCostUsd": { "title": "Cost ceiling (USD)", "minimum": 0, "type": "number", "description": "Stop once the run's charges would pass this amount." }, "concurrency": { "title": "Products in parallel", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many products are read at the same time.", "default": 2 } } }, "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 } } } } } } } } } }