/capterra/products/reviews

POST /api/capterra/products/reviews

Price: 10 credits

Get Capterra (capterra.com) product reviews by seo_id, seo_id/alias, or full product URL

How to use it

Get user reviews of a Capterra (capterra.com) software product by seo_id, 'seo_id/alias', or product URL. Returns title, text, pros, cons, rating breakdown, recommendation, author profile, incentive, switched-from and alternative products.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Capterra product identifier. Accepts seo_id ('176586'), seo_id/alias ('176586/Power-BI'), or full product URL ('https://www.capterra.com/p/176586/Power-BI/'). (examples: "176586", "176586/Power-BI", "https://www.capterra.com/p/176586/Power-BI/"; minLength: 1; pattern: ^(?:https?://[^\s]+|//[^\s]+|(?:www\.|capterra\.com)[^\s]*|\d+(?:/[^\s/?#]+)?)$)
• count integer required — Max number of reviews to return (min: 1; max: 10000)

Response

• @type string (default: "CapterraReview")
• id string required
• global_id string nullable
• text string nullable
• pros string nullable
• cons string nullable
• advice string nullable
• rating number nullable
• ratings object nullable
  • @type string (default: "CapterraReviewRatings")
  • ease_of_use number nullable
  • customer_support number nullable
  • functionality number nullable
  • value_for_money number nullable
• recommendation_rating number nullable
• written_date string nullable
• incentive string nullable
• is_anonymous boolean nullable
• source_site string nullable
• source_code string nullable
• source_tooltip string nullable
• chosen_reason string nullable
• switching_reason string nullable
• switched_from array (default: [])
  • @type string (default: "CapterraReviewProduct")
  • seo_id string required
  • alias string nullable
  • name string nullable
  • image string nullable
  • url string nullable
• alternatives array (default: [])
  • @type string (default: "CapterraReviewProduct")
  • seo_id string required
  • alias string nullable
  • name string nullable
  • image string nullable
  • url string nullable
• vendor_response string nullable
• author object nullable
  • @type string (default: "CapterraReviewAuthor")
  • name string nullable
  • job_title string nullable
  • company_size string nullable
  • industry string nullable
  • used_for string nullable
  • image string nullable
  • is_linkedin_verified boolean nullable
  • is_validated boolean nullable
  • validations array (default: [])
  • is_anonymous boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Product not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.