{
"openapi": "3.0.1",
"info": {
"title": "Capterra Reviews Scraper - Pros, Cons, Ratings & Switching",
"description": "Export every Capterra review for any software product: star ratings, 4 sub-ratings, pros and cons, reviewer role, industry, company size and country, plus why reviewers switched from competitors. Newest first, date and company-size filters, only-new mode.",
"version": "0.1",
"x-build-id": "TFPuJUlMwg6l1NP6H"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/headply~capterra-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-headply-capterra-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/headply~capterra-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-headply-capterra-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/headply~capterra-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-headply-capterra-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",
"required": [
"products"
],
"properties": {
"products": {
"title": "Products",
"type": "array",
"description": "Capterra product URLs such as https://www.capterra.com/p/135003/Slack/ (any Capterra country site works), Software Advice URLs, or plain product names like HubSpot CRM. One per line.",
"items": {
"type": "string"
}
},
"maxReviewsPerProduct": {
"title": "Max reviews per product",
"minimum": 0,
"type": "integer",
"description": "Stop after this many reviews for each product. 0 = all reviews.",
"default": 100
},
"sort": {
"title": "Order",
"enum": [
"most_recent",
"most_helpful"
],
"type": "string",
"description": "Newest first, or Capterra's 'most helpful' order. Date filters and 'only new reviews' always use newest first.",
"default": "most_recent"
},
"reviewsNewerThan": {
"title": "Only reviews newer than",
"type": "string",
"description": "Skip reviews written before this date. A date (2026-01-31) or a relative period (30 days, 6 months, 1 year)."
},
"onlyNewReviews": {
"title": "Only new reviews since the last run",
"type": "boolean",
"description": "For scheduled monitoring: each run returns only the reviews added since the previous run of this Actor for the same product and filters, so you pay only for what is new.",
"default": false
},
"ratings": {
"title": "Star ratings",
"type": "array",
"description": "Keep only reviews with these overall star ratings, for example 1 and 2 to collect complaints. Empty = all ratings.",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"enumTitles": [
"1 star",
"2 stars",
"3 stars",
"4 stars",
"5 stars"
]
}
},
"companySizes": {
"title": "Reviewer company size",
"type": "array",
"description": "Keep only reviewers from companies of these sizes. Empty = all sizes.",
"items": {
"type": "string",
"enum": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I"
],
"enumTitles": [
"Self-employed",
"2-10 employees",
"11-50 employees",
"51-200 employees",
"201-500 employees",
"501-1,000 employees",
"1,001-5,000 employees",
"5,001-10,000 employees",
"10,000+ employees"
]
}
},
"reviewerCountries": {
"title": "Reviewer countries",
"type": "array",
"description": "Two-letter country codes of reviewers to keep, for example us, gb, ca, in. Empty = all countries.",
"items": {
"type": "string"
}
},
"timeUsed": {
"title": "How long the reviewer used the product",
"type": "array",
"description": "Keep only reviewers who used the product for this long. Empty = all.",
"items": {
"type": "string",
"enum": [
"FreeTrial",
"LessThan6Months",
"LessThan12Months",
"LessThan2Years",
"MoreThan2Years"
],
"enumTitles": [
"Free trial",
"Less than 6 months",
"6-12 months",
"1-2 years",
"2+ years"
]
}
},
"includeProductSummary": {
"title": "Add a product summary row",
"type": "boolean",
"description": "One row per product with the total review count, average ratings (overall, ease of use, customer service, features, value for money), % who recommend it, the 1-5 star breakdown and the review summary pros and cons.",
"default": true
},
"includeSwitchingDetails": {
"title": "Add switching reasons and vendor replies",
"type": "boolean",
"description": "Match each review with its record on Software Advice (same review database) to add why the reviewer switched from another product, why they chose this one, the vendor's reply, how often they use it and whether the reviewer was verified. Done for full exports and for products with up to 500 reviews; for products with fewer than about 100 reviews Software Advice only shows the 10 most helpful ones.",
"default": true
},
"maxConcurrency": {
"title": "Max parallel requests",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "How many pages to load at the same time.",
"default": 10
}
}
},
"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
}
}
}
}
}
}
}
}
}
}