Matchmaking - Get Queue Statistics

Get the statistics for a queue.

POST https://titleId.playfabapi.com/Match/GetQueueStatistics

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
QueueName True

string

The name of the queue.

CustomTags

object

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

Responses

Name Type Description
200 OK

GetQueueStatisticsResult

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

GetQueueStatisticsRequest

Returns the matchmaking statistics for a queue. These include the number of players matching and the statistics related to the time to match statistics in seconds (average and percentiles). Statistics are refreshed once every 5 minutes. Servers can access all statistics no matter what the ClientStatisticsVisibility is configured to. Clients can access statistics according to the ClientStatisticsVisibility. Client requests are forbidden if all visibility fields are false.

GetQueueStatisticsResult
Statistics

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

GetQueueStatisticsRequest

Returns the matchmaking statistics for a queue. These include the number of players matching and the statistics related to the time to match statistics in seconds (average and percentiles). Statistics are refreshed once every 5 minutes. Servers can access all statistics no matter what the ClientStatisticsVisibility is configured to. Clients can access statistics according to the ClientStatisticsVisibility. Client requests are forbidden if all visibility fields are false.

Name Type Description
CustomTags

object

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

QueueName

string

The name of the queue.

GetQueueStatisticsResult

Name Type Description
NumberOfPlayersMatching

number

The current number of players in the matchmaking queue, who are waiting to be matched.

TimeToMatchStatisticsInSeconds

Statistics

Statistics representing the time (in seconds) it takes for tickets to find a match.

Statistics

Name Type Description
Average

number

The average.

Percentile50

number

The 50th percentile.

Percentile90

number

The 90th percentile.

Percentile99

number

The 99th percentile.

Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingUnauthorized 2056