Catalog - Get Item Reviews

Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds.

POST https://titleId.playfabapi.com/Catalog/GetItemReviews

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Required Type Description
Count True

number

Number of items to retrieve. This value is optional. Default value is 10.

AlternateId

CatalogAlternateId

An alternate ID associated with this item.

ContinuationToken

string

An opaque token used to retrieve the next page of items, if any are available.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Id

string

The unique ID of the item.

OrderBy

string

An OData orderBy used to order the results of the query. Possible values are Helpfulness, Rating, and Submitted (For example: "Submitted desc")

Responses

Name Type Description
200 OK

GetItemReviewsResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

CatalogAlternateId
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

GetItemReviewsRequest
GetItemReviewsResponse
Review

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code

CatalogAlternateId

Name Type Description
Type

string

Type of the alternate ID.

Value

string

Value of the alternate ID.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.

Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetItemReviewsRequest

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

ContinuationToken

string

An opaque token used to retrieve the next page of items, if any are available.

Count

number

Number of items to retrieve. This value is optional. Default value is 10.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Id

string

The unique ID of the item.

OrderBy

string

An OData orderBy used to order the results of the query. Possible values are Helpfulness, Rating, and Submitted (For example: "Submitted desc")

GetItemReviewsResponse

Name Type Description
ContinuationToken

string

An opaque token used to retrieve the next page of items, if any are available.

Reviews

Review[]

The paginated set of results.

Review

Name Type Description
CategoryRatings

object

The star rating associated with each selected category in this review.

HelpfulNegative

number

The number of negative helpfulness votes for this review.

HelpfulPositive

number

The number of positive helpfulness votes for this review.

IsInstalled

boolean

Indicates whether the review author has the item installed.

ItemId

string

The ID of the item being reviewed.

ItemVersion

string

The version of the item being reviewed.

Locale

string

The locale for which this review was submitted in.

Rating

number

Star rating associated with this review.

ReviewId

string

The ID of the review.

ReviewText

string

The full text of this review.

ReviewerEntity

EntityKey

The ID of the author of the review.

ReviewerId

string

Deprecated. Use ReviewerEntity instead. This property will be removed in a future release.

Submitted

string

The date and time this review was last submitted.

Title

string

The title of this review.

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047