/capterra/products

POST /api/capterra/products

Price: 10 credits

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

How to use it

Get full details of a Capterra (capterra.com) software product by seo_id, 'seo_id/alias', or product URL. Returns name, vendor, description, pricing, rating, pros/cons, features, categories, screenshots, awards.

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/?#]+)?)$)

Response

• @type string (default: "CapterraProduct")
• id string required (format: uuid)
• seo_id string required
• alias string nullable
• name string nullable
• short_description string nullable
• vendor_name string nullable
• image string nullable
• website_url string nullable
• pricing_starting_from string nullable
• pricing_unit string nullable
• pricing_currency string nullable
• pricing_model string nullable
• payment_frequency string nullable
• has_free_trial boolean nullable
• has_free_version boolean nullable
• rating number nullable
• review_count integer nullable
• ease_of_use_rating number nullable
• customer_support_rating number nullable
• value_for_money_rating number nullable
• functionality_rating number nullable
• description string nullable
• last_updated string nullable
• review_sentiment object nullable
  • @type string (default: "CapterraReviewSentiment")
  • positive object nullable
    • @type string (default: "CapterraReviewSentimentBucket")
    • count integer nullable
    • percentage integer nullable
  • neutral object nullable
    • @type string (default: "CapterraReviewSentimentBucket")
    • count integer nullable
    • percentage integer nullable
  • negative object nullable
    • @type string (default: "CapterraReviewSentimentBucket")
    • count integer nullable
    • percentage integer nullable
• review_distribution object nullable
  • @type string (default: "CapterraReviewDistribution")
  • one integer nullable
  • two integer nullable
  • three integer nullable
  • four integer nullable
  • five integer nullable
• review_topics array (default: [])
  • @type string (default: "CapterraReviewTopic")
  • name string required
  • review_count integer nullable
• pros array (default: [])
  • @type string (default: "CapterraProsCons")
  • description string nullable
  • sentiment integer nullable
• cons array (default: [])
  • @type string (default: "CapterraProsCons")
  • description string nullable
  • sentiment integer nullable
• categories array (default: [])
  • @type string (default: "CapterraProductCategory")
  • name string required
  • slug string nullable
  • url string nullable
• features array (default: [])
  • @type string (default: "CapterraFeature")
  • name string required
  • tooltip string nullable
  • rating number nullable
  • rating_count integer nullable
  • is_top boolean (default: false)
• screenshots array (default: [])
• videos array (default: [])
• awards array (default: [])
• alternatives array (default: [])
  • @type string (default: "CapterraAlternative")
  • id string required (format: uuid)
  • seo_id string nullable
  • alias string nullable
  • name string nullable
  • image string nullable
  • rating number nullable
  • review_count integer nullable
  • is_upgraded boolean (default: false)
  • url string nullable
• integrations array (default: [])
  • @type string (default: "CapterraIntegration")
  • id string required (format: uuid)
  • name string required
  • image string nullable
  • review_count integer nullable
  • url string nullable
• comparisons array (default: [])
  • @type string (default: "CapterraComparison")
  • seo_id string nullable
  • url string nullable
• shortlist_badges array (default: [])
  • @type string (default: "CapterraShortlistBadge")
  • name string required
  • year string nullable
  • alias string nullable
  • url string nullable
• deployment array (default: [])
• training array (default: [])
• support array (default: [])
• target_company_sizes array (default: [])
• url string 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.