/softwaresuggest/products

POST /api/softwaresuggest/products

Price: 10 credits

Get a SoftwareSuggest software product by URL or alias: overview, description, category, supported operating systems, average rating, review count, starting price, key features, company details, listed categories, mobile platforms, languages, business sizes, support options, integrations, social links, the review summary with pros and cons, screenshots and the product FAQ.

How to use it

Profile one business software product listed on SoftwareSuggest. For what users say about it, use softwaresuggest/products/reviews with the same alias.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — SoftwareSuggest product URL or its alias (examples: "https://www.softwaresuggest.com/bamboohr", "bamboohr"; minLength: 1)

Response

• @type string (default: "SoftwaresuggestProduct")
• alias string required
• name string required
• url string required
• image string nullable
• overview string nullable
• description string nullable
• category string nullable
• category_url string nullable
• application_category string nullable
• operating_systems array (default: [])
• rating number nullable
• review_count integer nullable
• starting_price number nullable
• starting_price_currency string nullable
• starting_price_unit string nullable
• features array (default: [])
• company_name string nullable
• headquarters string nullable
• address string nullable
• categories array (default: [])
  • @type string (default: "SoftwaresuggestProductRef")
  • alias string required
  • name string required
  • url string required
• mobile_platforms array (default: [])
• languages array (default: [])
• business_sizes array (default: [])
• support_options array (default: [])
• integrations array (default: [])
  • @type string (default: "SoftwaresuggestProductRef")
  • alias string required
  • name string required
  • url string required
• social_links array (default: [])
  • @type string (default: "SoftwaresuggestLink")
  • name string required
  • url string required
• review_summary string nullable
• pros array (default: [])
• cons array (default: [])
• screenshots array (default: [])
• faqs array (default: [])
  • @type string (default: "SoftwaresuggestFaq")
  • question string required
  • answer 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 — No SoftwareSuggest product at this alias 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.