Method: stats.get
Stay organized with collections
Save and categorize content based on your preferences.
Returns engagement and spend statistics in this application for the currently authenticated user.
HTTP request
GET https://games.googleapis.com/games/v1/stats
Request body
The request body must be empty.
Response body
A third party stats resource.
If successful, the response body contains data with the following structure:
JSON representation |
{
"churn_probability": number,
"num_purchases": integer,
"spend_percentile": number,
"days_since_last_played": integer,
"num_sessions": integer,
"num_sessions_percentile": number,
"avg_session_length_minutes": number,
"spend_probability": number,
"high_spender_probability": number,
"total_spend_next_28_days": number,
"kind": string
} |
Fields |
churn_probability |
number
The probability of the player not returning to play the game in the next day. E.g., 0, 0.1, 0.5, ..., 1.0. Not populated if there is not enough information.
|
num_purchases |
integer
Number of in-app purchases made by the player in this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.
|
spend_percentile |
number
The approximate spend percentile of the player in this game. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information.
|
days_since_last_played |
integer
Number of days since the player last played this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.
|
num_sessions |
integer
The approximate number of sessions of the player within the last 28 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.
|
num_sessions_percentile |
number
The approximation of the sessions percentile of the player within the last 30 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information.
|
avg_session_length_minutes |
number
Average session length in minutes of the player. E.g., 1, 30, 60, ... . Not populated if there is not enough information.
|
spend_probability |
number
The probability of the player going to spend the game in the next seven days. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information.
|
high_spender_probability |
number
The probability of the player going to spend beyond a threshold amount of money. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information.
|
total_spend_next_28_days |
number
The predicted amount of money that the player going to spend in the next 28 days. E.g., 1, 30, 60, ... . Not populated if there is not enough information.
|
kind |
string
Uniquely identifies the type of this resource. Value is always the fixed string games#statsResponse .
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/games
https://www.googleapis.com/auth/games_lite
For more information, see the OAuth 2.0 Overview.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# Method: stats.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.PlayerStats.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns engagement and spend statistics in this application for the currently authenticated user.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/stats`\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA third party stats resource.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"churn_probability\": number, \"num_purchases\": integer, \"spend_percentile\": number, \"days_since_last_played\": integer, \"num_sessions\": integer, \"num_sessions_percentile\": number, \"avg_session_length_minutes\": number, \"spend_probability\": number, \"high_spender_probability\": number, \"total_spend_next_28_days\": number, \"kind\": string } ``` |\n\n| Fields ||\n|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `churn_probability` | `number` The probability of the player not returning to play the game in the next day. E.g., 0, 0.1, 0.5, ..., 1.0. Not populated if there is not enough information. |\n| `num_purchases` | `integer` Number of in-app purchases made by the player in this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information. |\n| `spend_percentile` | `number` The approximate spend percentile of the player in this game. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information. |\n| `days_since_last_played` | `integer` Number of days since the player last played this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information. |\n| `num_sessions` | `integer` The approximate number of sessions of the player within the last 28 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information. |\n| `num_sessions_percentile` | `number` The approximation of the sessions percentile of the player within the last 30 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information. |\n| `avg_session_length_minutes` | `number` Average session length in minutes of the player. E.g., 1, 30, 60, ... . Not populated if there is not enough information. |\n| `spend_probability` | `number` The probability of the player going to spend the game in the next seven days. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information. |\n| `high_spender_probability` | `number` The probability of the player going to spend beyond a threshold amount of money. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information. |\n| `total_spend_next_28_days` | `number` The predicted amount of money that the player going to spend in the next 28 days. E.g., 1, 30, 60, ... . Not populated if there is not enough information. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#statsResponse`. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]