| Name | Type | Required | Description |
|---|---|---|---|
| filter | string | ✔ | recent – sorted by creation time updated – sorted by last updated time all – (default) sorted by helpfulness, with sliding windows based on day_range parameter, will always find results to return. If paging through the reviews with cursor then choose either the recent option or the updated option to eventually receive an empty response list. |
| language | string | ✔ | see https://partner.steamgames.com/doc/store/localization/languages (and use the API language code list) or pass “all” for all reviews |
| day_range | string | ✔ | range from now to n days ago to look for helpful reviews. Only applicable for the “all” filter. Maximum value is 365. |
| cursor | string | ✔ | reviews are returned in batches of 20, so pass "*" for the first set, then the value of "cursor" that was returned in the response for the next set, etc. Note that cursor values may contain characters that need to be URLEncoded for use in the querystring. |
| review_type | string | ✔ | all – all reviews (default) positive – only positive reviews negative – only negative reviews |
| purchase_type | string | ✔ | all – all reviews non_steam_purchase – reviews written by users who did not pay for the product on Steam steam – reviews written by users who paid for the product on Steam (default) |
| num_per_page | string | ✔ | by default, up to 20 reviews will be returned. More reviews can be returned based on this parameter (with a maximum of 100 reviews) |
| filter_offtopic_activity | number | by default, off-topic reviews (aka "Review Bombs") are filtered out and are not returned in this API. Pass 0 to include them. See here. |
success - 1 if the query was successfulquery_summary - Returned in the first requestnum_reviews - The number of reviews returned in this responsereview_score - The review scorereview_score_desc - The description of the review scoretotal_positive - Total number of positive reviewstotal_negative - Total number of negative reviewstotal_reviews - Total number of reviews matching the query parameterscursor - The value to pass into the next request as the cursor to retrieve the next batch of reviewsreviewsrecommendationid - The unique id of the recommendationauthorsteamid - the user’s SteamIDnum_games_owned - number of games owned by the usernum_reviews - number of reviews written by the userplaytime_forever - lifetime playtime tracked in this appplaytime_last_two_weeks - playtime tracked in the past two weeks for this appplaytime_at_review - playtime when the review was writtendeck_playtime_at_review - playtime on Steam Deck when the review was writtenlast_played - time for when the user last playedlanguage - language the user indicated when authoring the reviewreview - text of written reviewtimestamp_created - date the review was created (unix timestamp)timestamp_updated - date the review was last updated (unix timestamp)voted_up - true means it was a positive recommendationvotes_up - the number of users that found this review helpfulvotes_funny - the number of users that found this review funnyweighted_vote_score - helpfulness scorecomment_count - number of comments posted on this reviewsteam_purchase - true if the user purchased the game on Steamreceived_for_free - true if the user checked a box saying they got the app for freewritten_during_early_access - true if the user posted this review while the game was in Early Accessdeveloper_response - text of the developer response, if anytimestamp_dev_responded - Unix timestamp of when the developer responded, if applicableprimarily_steam_deck - Did the reviewer play this game primarily on Steam Deck at the time of writing
|