POST /api/capterra/products/comparisons
Price: 20 credits
Compare two Capterra (capterra.com) software products side by side
Compare two Capterra (capterra.com) software products: returns one record per product, in the order given, with vendor details, ratings, review sentiment and snippets, features with their ratings, integrations and alternatives.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)products array required — Two Capterra products, each a seo_id, seo_id/alias or product URL (examples: ["176586","208764"], ["176586/Power-BI","https://www.capterra.com/p/208764/Tableau/"]; minItems: 2; maxItems: 2)@type string (default: "CapterraComparedProduct")id string required (format: uuid)seo_id string requiredalias string nullablename string nullableformer_name string nullableimage string nullablebest_for string nullablevendor_name string nullablevendor_location string nullablevendor_founded_year integer nullablecategory object nullable@type string (default: "CapterraComparedCategory")id string nullablename string requiredalias string nullablereview_count integer nullableurl string nullablecategories array (default: [])@type string (default: "CapterraComparedCategory")id string nullablename string requiredalias string nullablereview_count integer nullableurl string nullablerating number nullablereview_count integer nullableease_of_use_rating number nullablecustomer_support_rating number nullablefunctionality_rating number nullablevalue_for_money_rating number nullablepositive_review_count integer nullableneutral_review_count integer nullablenegative_review_count integer nullablepositive_topics array (default: [])neutral_topics array (default: [])negative_topics array (default: [])positive_snippet_count integer nullablenegative_snippet_count integer nullablepositive_snippets array (default: [])@type string (default: "CapterraReviewSnippet")text string requiredsentiment string nullablereview_id string nullablewritten_date integer nullablesource_site string nullableauthor_name string nullableauthor_job_title string nullableauthor_industry string nullablenegative_snippets array (default: [])@type string (default: "CapterraReviewSnippet")text string requiredsentiment string nullablereview_id string nullablewritten_date integer nullablesource_site string nullableauthor_name string nullableauthor_job_title string nullableauthor_industry string nullablehas_free_trial boolean nullablehas_free_version boolean nullabledeployment array (default: [])support array (default: [])training array (default: [])category_features array (default: [])@type string (default: "CapterraComparedFeature")id string nullablename string requireddescription string nullablerating number nullablerating_count integer nullableis_offered boolean nullablefeatures array (default: [])@type string (default: "CapterraComparedFeature")id string nullablename string requireddescription string nullablerating number nullablerating_count integer nullableis_offered boolean nullableintegrations array (default: [])@type string (default: "CapterraComparedProductRef")seo_id string nullablealias string nullablename string requiredimage string nullablerating number nullablereview_count integer nullablevendor_name string nullablevendor_location string nullablevendor_founded_year integer nullableurl string nullablealternatives array (default: [])@type string (default: "CapterraComparedProductRef")seo_id string nullablealias string nullablename string requiredimage string nullablerating number nullablereview_count integer nullablevendor_name string nullablevendor_location string nullablevendor_founded_year integer nullableurl string nullableshortlist_categories array (default: [])screenshots array (default: [])last_updated integer nullableurl string nullable422 — A comparison needs two different products Check the fields against this schema. A URN with the wrong prefix is the most common cause.404 — Capterra has no comparison page for this pair of products408 — 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.