Catalog - Report Item Review

Service:

Economy

API Version:

241025

Submit a report for a review

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

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	Type	Description
AlternateId	CatalogAlternateId	An alternate ID of the item associated with the review.
ConcernCategory	ConcernCategory	The reason this review is being reported.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
ItemId	string	The string ID of the item associated with the review.
Reason	string	The string reason for this report.
ReviewId	string	The ID of the review to submit a report for.

Responses

Name	Type	Description
200 OK	ReportItemReviewResponse
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
ConcernCategory
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
ReportItemReviewRequest	Submit a report for an inappropriate review, allowing the submitting user to specify their concern.
ReportItemReviewResponse

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.

ConcernCategory

Name	Type	Description
ChildExploitation	string
MalwareOrVirus	string
MisleadingApp	string
None	string
OffensiveContent	string
PoorPerformance	string
PrivacyConcerns	string
Profanity	string
ReviewResponse	string
SpamAdvertising	string

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

ReportItemReviewRequest

Submit a report for an inappropriate review, allowing the submitting user to specify their concern.

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID of the item associated with the review.
ConcernCategory	ConcernCategory	The reason this review is being reported.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
ItemId	string	The string ID of the item associated with the review.
Reason	string	The string reason for this report.
ReviewId	string	The ID of the review to submit a report for.

ReportItemReviewResponse

Error Codes

Name	Code
DatabaseThroughputExceeded	1113