/gartner/markets

POST /api/gartner/markets

Price: 20 credits

Get Gartner Peer Insights (gartner.com) market details by market seoName or full market URL

How to use it

Get a Gartner Peer Insights (gartner.com) market (software category) profile by seoName or market URL. Returns the market name, subtitle, definition/description, parent category, total review count, product count, the mandatory and common features that define the market, the keywords reviewers are asked to cover, the Gartner research documents published for the market (Magic Quadrant, Critical Capabilities, Market Guide, Voice of the Customer), and the peer lessons learned (key buyer takeaways with their publication date). Use gartner/markets/products to list the products within the market.

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.-]*)$)

Response

• @type string (default: "GartnerMarket")
• id string nullable
• ref_id string nullable
• name string required
• alias string nullable
• subtitle string nullable
• description string nullable
• review_count integer nullable
• product_count integer nullable
• is_service boolean nullable
• parent_category object nullable
  • @type string (default: "GartnerMarketParentCategory")
  • name string required
  • alias string nullable
  • url string nullable
• features_updated_at string nullable
• mandatory_features array (default: [])
• common_features array (default: [])
• review_guidance_keywords array (default: [])
• research_documents array (default: [])
  • @type string (default: "GartnerMarketResearchDocument")
  • id string required
  • document_type string required
  • url string required
• lessons_learned object nullable
  • @type string (default: "GartnerMarketLessonsLearned")
  • lessons array (default: [])
  • published_date string nullable
  • url string nullable
• 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 — 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.