GET /api/reviews
Supported formats: json
Returns a list of Game User Reviews
linked in order of when they were made of newest to oldest. A game_id
can be specified to get the reviews of a particular game.
Example
GEThttps://api.boardgameatlas.com/api/reviews?client_id=
Parameters
If you provide a Authorization header with a Bearer access_token you get through OAuth then it will provide the data for the logged in user.
These are all the posible parameters to add to the request to filter or change the results based on how each function.
Parameter | Type | Example | Details |
---|---|---|---|
pretty | Boolean | true | Formats the json to be easier to read. |
limit | Number | 10 | Limits the number of results returned. |
skip | Number | 10 | Skips the number of results provided. It's generally used for paging results. |
game_id | String | GP7Y2xOUzj | The id of a specific game |
username | String | trentellingsen | The name of the user you want to get all the reviews for. |
order_by | String | date | This orders the reviews from newest to oldest reviews |
after_date | Date | 2019-05-28T17:13:05.371Z | This returns reviews after the specified date. |
current_user | Boolean | true | Gets reviews for the currently logged in user. |
description_required | Boolean | true | Returns only reviews with a description |
rating | Int | 3 | Returns reviews with a rating equal to the specified number. |
include_summary | Boolean | true | A summary that includes # of reviews, the average if you've specified a game_id, and number of reviews by rating |
include_game | Boolean | true | A full game object will be returned. |
include_user | Boolean | true | A user object will be returned. |