/gartner/markets/products

POST /api/gartner/markets/products

Price: 20 credits

List Gartner Peer Insights (gartner.com) products in a market with optional reviewer filters

How to use it

List the products in a Gartner Peer Insights (gartner.com) market (e.g. 'data-loss-prevention'), ranked and filterable. Returns each product with average rating, review count, star-rating distribution, vendor, description, review summaries and ranked alternatives. Filter by reviewer company size, industry and region, restrict to products reviewed in the last 12 months, and choose the result ordering.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• market string required — Gartner Peer Insights market identifier. Accepts a market seoName ('data-loss-prevention') or full market URL ('https://www.gartner.com/reviews/market/data-loss-prevention'). (examples: "data-loss-prevention", "https://www.gartner.com/reviews/market/data-loss-prevention"; minLength: 1; pattern: ^(?:https?://[^\s]+|//[^\s]+|(?:www\.)?gartner\.com[^\s]*|[a-z0-9][a-z0-9.-]*)$)
• count integer required — Max number of products to return (min: 1)
• sort string — Result ordering (default: "ratingsCount_desc"; one of: "ratingsCount_desc", "ratingsCount_asc", "averageRating_desc", "averageRating_asc", "name_asc", "name_desc")
• reviewed_last_12_months boolean — Only include products reviewed in the last 12 months (default: false)
• company_size array — Filter by reviewer company-size revenue band (default: []; one of: "<50M USD", "50M-1B USD", "1B-10B USD", "10B+ USD", "Gov't/PS/Ed")
• industry array — Filter by reviewer industry (default: []; one of: "Banking", "Construction", "Consumer Goods", "Education", "Energy and Utilities", "Finance (non-banking)", "Government", "Hardware", "Healthcare and Biotech", "Insurance (except health)", "IT Services", "Manufacturing", "Media", "Miscellaneous", "Real Estate", "Retail", "Services (non-Government)", "Software", "Telecommunication", "Transportation", "Travel and Hospitality")
• region array — Filter by reviewer deployment region (default: []; one of: "North America", "Asia/Pacific", "Europe, Middle East and Africa", "Latin America")

Response

• @type string (default: "GartnerMarketProduct")
• id string required
• name string required
• alias string nullable
• average_rating number nullable
• review_count integer nullable
• rating_distribution object nullable
  • @type string (default: "GartnerRatingDistribution")
  • star_1 integer (default: 0)
  • star_2 integer (default: 0)
  • star_3 integer (default: 0)
  • star_4 integer (default: 0)
  • star_5 integer (default: 0)
• image string nullable
• description string nullable
• vendor_name string nullable
• vendor_alias string nullable
• is_legacy boolean nullable
• review_summaries array (default: [])
• alternatives array (default: [])
  • @type string (default: "GartnerProductAlternative")
  • id string required
  • name string required
  • alias string nullable
  • average_rating number nullable
  • review_count integer nullable
  • image string nullable
  • vendor_name string nullable
  • vendor_alias string nullable
  • url string nullable
• url string nullable
• position integer required

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 — Market 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.