/microsoftstore/apps/reviews/summary

POST /api/microsoftstore/apps/reviews/summary

Price: 1 credit

Get the aggregate review summary for a Microsoft Store product by Store product ID or URL

How to use it

Get the aggregate rating and review summary for a Microsoft Store product (app, game, or other catalog item) by its 12-character Store product ID or product page URL. Returns the average rating, total rating and written-review counts, the rating availability status, the per-star distribution (number of ratings and written reviews for each 1-5 star bucket), and the most critical and most favorable reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• app string required — Microsoft Store product as a 12-character Store ID or a product page URL (examples: "9NCBCSZSJRSB", "9WZDNCRFJBMP", "https://apps.microsoft.com/detail/9NCBCSZSJRSB"; minLength: 1)
• market string — Store market (default: "US"; one of: "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "BR", "MX", "IN", "JP", "KR", "TR")
• locale string — Content language (default: "en-US"; one of: "en-US", "en-GB", "en-CA", "en-AU", "de-DE", "fr-FR", "it-IT", "es-ES", "nl-NL", "pt-BR", "es-MX", "ja-JP", "ko-KR", "tr-TR")

Response

• @type string (default: "MicrosoftstoreReviewsSummary")
• rating_status string nullable
• average_rating number nullable
• rating_count integer (default: 0)
• review_count integer (default: 0)
• source string nullable
• star_distribution array (default: [])
  • @type string (default: "MicrosoftstoreStarBucket")
  • star integer required
  • rating_count integer (default: 0)
  • review_count integer (default: 0)
• most_critical_review object nullable
  • @type string (default: "MicrosoftstoreReview")
  • id string required
  • author string nullable
  • rating integer (default: 0)
  • text string nullable
  • submitted_at string nullable
  • helpful_count integer (default: 0)
  • helpful_negative_count integer (default: 0)
  • os_version string nullable
  • device_family string nullable
  • is_verified boolean (default: false)
  • is_revised boolean (default: false)
• most_favorable_review object nullable
  • @type string (default: "MicrosoftstoreReview")
  • id string required
  • author string nullable
  • rating integer (default: 0)
  • text string nullable
  • submitted_at string nullable
  • helpful_count integer (default: 0)
  • helpful_negative_count integer (default: 0)
  • os_version string nullable
  • device_family string nullable
  • is_verified boolean (default: false)
  • is_revised boolean (default: false)

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.