ALE Metrics API

ALE Metrics API provides access to aggregated cohort data of your games. The ALE API can be accessed by utilizing your Studios API key. Find your Studio API Key to access these functions on the ByteBrew dashboard under your Studio Settings.

API Authentication

tag

To authenticate API requests to the ALE Metrics API, you must request a authentication token by sending a POST request. To send the request to retrieve the authentication token, the token request must have a JSON body containing the following:

fiber_manual_record
email
fiber_manual_record
apiKey
Authentication Token Request
                                
                                
                                    
                                POST Endpoint: https://ale.bytebrew.io/auth/generatetoken


                                
                                
                            
                                
                                {
                                    "email": "myemail@something.com",
                                    "apiKey": "SOMEAPIKEYYOUHAVE"
                                }
                                
                            

Data Partner API Authentication

tag

To authenticate API requests to the ALE Metrics API as a Data Partner, you must request a authentication token by sending a POST request. And the user requesting access must be attached to a external studios apps/games as a Data Partner role. To send the request to retrieve the authentication token, the token request must have a JSON body containing the following:

fiber_manual_record
email
fiber_manual_record
apiKey
Authentication Token Request
                                
                                
                                    
                                POST Endpoint: https://ale.bytebrew.io/auth/datapartner/generatetoken


                                
                                
                            
                                
                                {
                                    "email": "myemail@something.com",
                                    "apiKey": "SOMEAPIKEYYOUHAVE"
                                }
                                
                            
Authentication Token Response

The authenication token request will return a response containing the "token" to use when requesting data from the ALE API. See an example "token" response:

                                
                                
                                
                                {
                                    "token": "AEVENLONGERSCRAMBLEOFASCIICHARACTERSGIVENBYTIMTHEMAGICIAN"
                                }
                                
                                
                            

Every request for API data must have an Authentication Header. See an example Authentication Header below:

                                
                                
                                
                                Authorization: Bearer AEVENLONGERSCRAMBLEOFASCIICHARACTERSGIVENBYTIMTHEMAGICIAN
                                
                                
                            

User Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about your users in your games.

User Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/userdata

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/userdata

                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/userdata?startDate=2021-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Users": 249
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/userdata?startDate=2021-05-15&endDate=2021-06-20&breakdown=date,device

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Users": 10,
                                            "Date": "2021-06-08",
                                            "Device": "SM-A102U"
                                        },
                                        {
                                            "Users": 34,
                                            "Date": "2021-06-08",
                                            "Device": "iPhone12,3"
                                        },
                                        {
                                            "Users": 12,
                                            "Date": "2021-05-19",
                                            "Device": "iPhone11,2"
                                        },
                                        {
                                            "Users": 22,
                                            "Date": "2021-06-01",
                                            "Device": "iPhone11,8"
                                        },
                                        {
                                            "Users": 5,
                                            "Date": "2021-06-01",
                                            "Device": "iPhone8,2"
                                        }    
                                    ]
                                }        
                                
                                
                            

Session Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about the sessions in your games.

Session Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessions

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/sessions

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessions?startDate=2023-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Sessions": 1034
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessions?startDate=2023-06-01&breakdown=date,device&endDate=2023-06-14

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Sessions": 1,
                                            "Date": "2023-06-02",
                                            "Device": "Redmi Note 8"
                                        },
                                        {
                                            "Sessions": 1,
                                            "Date": "2023-06-01",
                                            "Device": "SM-M225FV"
                                        },
                                        {
                                            "Sessions": 1,
                                            "Date": "2023-06-01",
                                            "Device": "SM-A125F"
                                        },
                                        {
                                            "Sessions": 3,
                                            "Date": "2023-06-07",
                                            "Device": "Redmi Note 8 Pro"
                                        }
                                    ]
                                }        
                                
                                
                            

Session Length Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about the session lengths in your games.

Session Length Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlength

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/sessionlength

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlength?startDate=2023-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "SessionTime": 573.34
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlength?startDate=2023-06-01&breakdown=date,device&endDate=2023-06-14

                                Response: 
                                {
                                    "data": [
                                        {
                                            "SessionTime": 76,
                                            "Date": "2023-06-06",
                                            "Device": "SM-A326U"
                                        },
                                        {
                                            "SessionTime": 8,
                                            "Date": "2023-06-04",
                                            "Device": "SM-G960U"
                                        },
                                        {
                                            "SessionTime": 42.5,
                                            "Date": "2023-06-08",
                                            "Device": "SM-A705MN"
                                        },
                                        {
                                            "SessionTime": 66,
                                            "Date": "2023-06-11",
                                            "Device": "SM-A225M"
                                        },
                                        {
                                            "SessionTime": 31,
                                            "Date": "2023-06-06",
                                            "Device": "SM-A035M"
                                        }
                                    ]
                                }        
                                
                                
                            

Playtime Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about the playtime in your games.

Playtime Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtime

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/playtime

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtime?startDate=2023-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Playtime": 1542
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtime?startDate=2023-06-01&breakdown=date,device&endDate=2023-06-14

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Playtime": 253,
                                            "Date": "2023-06-01",
                                            "Device": "SM-M225FV"
                                        },
                                        {
                                            "Playtime": 260.5,
                                            "Date": "2023-06-03",
                                            "Device": "SM-A127F"
                                        },
                                        {
                                            "Playtime": 21,
                                            "Date": "2023-06-07",
                                            "Device": "SM-A705MN"
                                        },
                                        {
                                            "Playtime": 49,
                                            "Date": "2023-06-01",
                                            "Device": "SM-A515F"
                                        },
                                        {
                                            "Playtime": 478,
                                            "Date": "2023-06-01",
                                            "Device": "SM-A035M"
                                        }
                                    ]
                                }        
                                
                                
                            

Retention Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about the number of users in your games that retain.

Retention Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/retention

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/retention

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/retention?startDate=2023-06-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "created_date": "2023-06-01",
                                            "day_0": 18,
                                            "day_1": 3,
                                            "day_2": 2,
                                            "day_3": 0,
                                            "day_4": 1,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        },
                                        {
                                            "created_date": "2023-06-02",
                                            "day_0": 15,
                                            "day_1": 0,
                                            "day_2": 0,
                                            "day_3": 2,
                                            "day_4": 2,
                                            "day_5": 1,
                                            "day_6": 1,
                                            "day_7": 0
                                        },
                                        {
                                            "created_date": "2023-06-03",
                                            "day_0": 17,
                                            "day_1": 1,
                                            "day_2": 1,
                                            "day_3": 1,
                                            "day_4": 1,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/retention?startDate=2023-06-01&breakdown=country&endDate=2023-06-14

                                Response: 
                                {
                                    "data": [
                                        {
                                            "created_date": "2023-06-01",
                                            "Country": "PH",
                                            "day_0": 4,
                                            "day_1": 0,
                                            "day_2": 0,
                                            "day_3": 0,
                                            "day_4": 0,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        },
                                        {
                                            "created_date": "2023-06-01",
                                            "Country": "TR",
                                            "day_0": 1,
                                            "day_1": 0,
                                            "day_2": 0,
                                            "day_3": 0,
                                            "day_4": 0,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        },
                                        {
                                            "created_date": "2023-06-01",
                                            "Country": "US",
                                            "day_0": 1,
                                            "day_1": 0,
                                            "day_2": 0,
                                            "day_3": 0,
                                            "day_4": 0,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        },
                                        {
                                            "created_date": "2023-06-01",
                                            "Country": "AE",
                                            "day_0": 1,
                                            "day_1": 0,
                                            "day_2": 0,
                                            "day_3": 0,
                                            "day_4": 0,
                                            "day_5": 0,
                                            "day_6": 0,
                                            "day_7": 0
                                        }
                                    ]
                                }        
                                
                                
                            

DAU Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about the number of DAU in your games.

DAU Data Endpoint

                                
                                
                                    
                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/dau

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/dau

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/dau?startDate=2023-06-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "DAU": 30
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/dau?startDate=2023-06-01&breakdown=country,date&endDate=2023-06-14

                                Response: 
                                {
                                    "data": [
                                        {
                                            "DAU": 9,
                                            "Country": "IN",
                                            "Date": "2023-06-03"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "PH",
                                            "Date": "2023-06-13"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "ET",
                                            "Date": "2023-06-09"
                                        },
                                        {
                                            "DAU": 5,
                                            "Country": "BD",
                                            "Date": "2023-06-05"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "BE",
                                            "Date": "2023-06-09"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "ID",
                                            "Date": "2023-06-12"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "UA",
                                            "Date": "2023-06-01"
                                        },
                                        {
                                            "DAU": 1,
                                            "Country": "LB",
                                            "Date": "2023-06-05"
                                        }
                                    ]
                                }        
                                
                                
                            

Progression Data

tag smartphoneMobile Only

Using this endpoint in the ALE API, you can get high level cohort data about your user's progression data in your games.

Progression Data Endpoint

                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/progressiondata

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
ProgressionType
fiber_manual_record
Environment
fiber_manual_record
Stage
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/progressiondata?startDate=2021-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Events": 11889
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/progressiondata?startDate=2021-05-15&endDate=2021-06-20&breakdown=date,progressiontype,environment

                                Response: 
                                {
                                    "data": [
                                        {
                                            "Events": 2,
                                            "Date": "2021-06-03",
                                            "ProgressionType": "Started",
                                            "Environment": "Main"
                                        },
                                        {
                                            "Events": 118,
                                            "Date": "2021-06-03",
                                            "ProgressionType": "Completed",
                                            "Environment": "Levels"
                                        },
                                        {
                                            "Events": 35,
                                            "Date": "2021-05-18",
                                            "ProgressionType": "Started",
                                            "Environment": "Levels"
                                        },
                                        {
                                            "Events": 37,
                                            "Date": "2021-06-05",
                                            "ProgressionType": "Failed",
                                            "Environment": "Levels"
                                        },
                                        {
                                            "Events": 63,
                                            "Date": "2021-06-05",
                                            "ProgressionType": "Completed",
                                            "Environment": "Levels"
                                        },
                                        ...
                                    ]
                                }      
                                
                                
                            

Monetization Revenue Data

tag smartphoneMobile Only

Using this endpoint in the ALE API, you can get high level cohort data about your game's revenue broken down by ad revenue and purchase revenue.

Monetization Revenue Data Endpoint

                                
                                
                                  
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationrevenue

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
Country
fiber_manual_record
Platform

Example Query #1

                                
                                
                                
                                
                                    GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationrevenue?startDate=2021-03-01

                                    Response: 
                                    {
                                    "data": {
                                        "purchaseData": [
                                            {
                                                "Revenue": 432.68
                                            }
                                        ],
                                        "monetizationData": [
                                            {
                                                "Revenue": 255.20
                                            }
                                        ]
                                    }
                                } 
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationrevenue?startDate=2021-05-01&endDate=2021-06-20&breakdown=date,country

                                Response: 
                                {
                                "data": {
                                    "purchaseData": [
                                        {
                                            "Revenue": 24.28,
                                            "Date": "2021-05-26",
                                            "Country": "US"
                                        }
                                    ],
                                    "monetizationData": [
                                        {
                                            "Revenue": 10.059822,
                                            "Date": "2021-06-23",
                                            "Country": "US"
                                        },
                                        {
                                            "Revenue": 12.11,
                                            "Date": "2021-05-01",
                                            "Country": "BR"
                                        },
                                        {
                                            "Revenue": 11.270238,
                                            "Date": "2021-05-13",
                                            "Country": "US"
                                        },
                                        ...
                                    ]
                                    }
                                }     
                                
                                
                            

Monetization Purchase Data

tag smartphoneMobile Only

Using this endpoint in the ALE API, you can get high level cohort data about your games' purchase revenue.

Monetization Purchase Data Endpoint

                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationpurchasedata

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
Platform
fiber_manual_record
Item
fiber_manual_record
Category
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationpurchasedata?startDate=2021-03-01

                                Response: 
                                {
                                "data": [
                                    {
                                        "Purchases": 11,
                                        "Revenue": 47.39
                                    }
                                ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationrevenue?startDate=2021-05-01&endDate=2021-06-20&breakdown=item,country

                                Response: 
                                {
                                "data": [
                                    {
                                        "Purchases": 1,
                                        "Revenue": 4.99,
                                        "Item": "gold_pack2",
                                        "Country": "US"
                                    }
                                ]
                                }       
                                
                                
                            

Purchasing Users Data

tag smartphoneMobile Only

Using this endpoint in the ALE API, you can get high level cohort data about your games' unique purchasing users.

Monetization Purchasing Users Data Endpoint

                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasingusersdata

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
Platform
fiber_manual_record
Item
fiber_manual_record
Category
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasingusersdata?startDate=2023-03-01

                                Response: 
                                {
                                    "data": [
                                        {
                                            "PurchasingUsers": 11
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasingusersdata?startDate=2023-05-01&endDate=2023-06-20&breakdown=date,country

                                Response: 
                                {
                                    "data": [
                                        {
                                            "PurchasingUsers": 3,
                                            "Date": "2023-05-04",
                                            "Country": "US"
                                        },
                                        {
                                            "PurchasingUsers": 1,
                                            "Date": "2023-05-16",
                                            "Country": "US"
                                        },
                                        {
                                            "PurchasingUsers": 2,
                                            "Date": "2023-05-15",
                                            "Country": "US"
                                        }
                                    ]
                                }       
                                
                                
                            

Monetization Ad Revenue Data

tag smartphoneMobile Only

Using this endpoint in the ALE API, you can get high level cohort data about your games' ad revenue.

Monetization Ad Revenue Data Endpoint

                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationadsdata


                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
gameId: The Game IDs from your account you want to query. In this field, you have the option to give: (1) an array of gameId's you want to query or (2) leave the field empty. If left empty or ommited, the system will auto query your studio's games.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
Country
fiber_manual_record
Platform
fiber_manual_record
Network
fiber_manual_record
AdType
fiber_manual_record
AdUnit
fiber_manual_record
Placement

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationadsedata?startDate=2021-03-01

                                Response: 
                                {
                                "data": [
                                    {
                                        "fillRate": 0.72,
                                        "impressions": 7825,
                                        "ecpm": 18.7708,
                                        "revenue": 146.87
                                    }
                                ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/monetizationadsedata?startDate=2021-05-01&endDate=2021-06-20&breakdown=network,adtype

                                Response: 
                                {
                                "data": [
                                    {
                                        "fillRate": 0.5263157894736843,
                                        "impressions": 0,
                                        "ecpm": 0,
                                        "revenue": 0,
                                        "Network": "Unity Ads",
                                        "AdType": "rewarded"
                                    },
                                    {
                                        "fillRate": 0.9368611397942536,
                                        "impressions": 98,
                                        "ecpm": 0.10928868055555555,
                                        "revenue": 0.020487,
                                        "Network": "Chartboost",
                                        "AdType": "rewarded"
                                    },
                                    {
                                        "fillRate": 0.29438577815626993,
                                        "impressions": 0,
                                        "ecpm": 0,
                                        "revenue": 0,
                                        "Network": "Unity Ads",
                                        "AdType": "interstitial"
                                    },
                                    {
                                        "fillRate": 0.8797688924194946,
                                        "impressions": 0,
                                        "ecpm": 0,
                                        "revenue": 0,
                                        "Network": "Chartboost",
                                        "AdType": "interstitial"
                                    },
                                    {
                                        "fillRate": 1,
                                        "impressions": 4,
                                        "ecpm": 0.1586748409090909,
                                        "revenue": 0.006980999999999999,
                                        "Network": "AdMob Network",
                                        "AdType": "interstitial"
                                    }
                                ]
                                }       
                                
                                
                            

Custom Event Data

tag

Using this endpoint in the ALE API, you can get high level cohort data about your custom events in your games.

Custom Event Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/customeventdata

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/customeventdata

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give a Game ID due to the expansive nature of custom events.
fiber_manual_record
events: The specific custom events you want to search for, ex. "last_kingdom_enter". In this field, you have the option to give: (1) an array of custom events you want to filter or (2) leave the field empty and it will query all custom events.
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
platform: The platforms you want to the data filtered by. In this field, you have the option to give: (1) an array of "iOS" or "Android" you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from both platforms.
fiber_manual_record
aggregator: Optionial functions to define how you want to aggregate your event data. This is optional and can be left empty or ommited. See list of available aggregators:
fiber_manual_record
MeanCount
fiber_manual_record
MeanValue
fiber_manual_record
ValueSum
fiber_manual_record
Unique
fiber_manual_record
Count
fiber_manual_record
breakdown: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Game
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
Event
fiber_manual_record
Value

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/customeventdata?startDate=2021-03-01&aggregator=count

                                Response: 
                                {
                                "data": [
                                    {
                                        "Count": 3760
                                    }
                                ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/customeventdata?startDate=2021-05-01&endDate=2021-06-20&aggregator=count&breakdown=event

                                Response: 
                                {
                                "data": [
                                    {
                                        "Count": 421,
                                        "Event": "VCPurchase"
                                    },
                                    {
                                        "Count": 140,
                                        "Event": "EquippedNewItem"
                                    },
                                    {
                                        "Count": 760,
                                        "Event": "VFX_OFF"
                                    },
                                    {
                                        "Count": 320,
                                        "Event": "MUSIC_ON"
                                    }
                                ]
                                }       
                                
                                
                            

Event Breakdown Data

tag

Using this endpoint in the ALE API, you can get granular level data about your custom events in your game.

Event Breakdown Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/eventbreakdowndata

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/analytics/eventbreakdowndata

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
(Required) typeEvent: The specific custom event you want to breakdown and query for, ex. "last_kingdom_enter".
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
aggregators: A JSON array that contains all information on how you want to aggregate your event data. Make sure you Encode the JSON array before sending to the API.
fiber_manual_record
param: Set the sub-parameter you want the aggregate operator to target.
fiber_manual_record
operator: Pick one of the following operators - 'AVG', 'MEDIAN', 'SUM', 'MIN', 'MAX'
                                                

                                                [{"param": "SUB_PARAMETER", "operator": "AVG" | "MEDIAN" | "SUM" | "MIN" | "MAX"}]
                                                
                                                Example Aggregate array:
                                                [{"param": "level", "operator": "AVG"}]
                                                
                                                
                                            
fiber_manual_record
subParamFilter: A dictionary with each key is a sub-parameter and its value is a nested JSON filter. Make sure you Encode the JSON dictionary before sending to the API.
fiber_manual_record
operator: Pick one of the following operators - '=', '!=', '>=', '>', '<', '<='
fiber_manual_record
value: Set the value you want to compare and query for.
                                                
                                                { "SUB_PARAMETER": { "operator": "=" | "!=" | ">=" | ">" | "<" | "<=", "value": "VALUE" } }

                                                Example Sub-Param Filter:
                                                { "level": { "operator": "=", "value": "5" }, "character": { "operator": "=", "value": "Viking" } }
                
                
                                                
                                                
                                            
fiber_manual_record
eventBreakdowns: Optionial dimensions to define in an array to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Date
fiber_manual_record
BuildVersion
fiber_manual_record
OSVersion
fiber_manual_record
Country
fiber_manual_record
Device
fiber_manual_record
CUSTOM_SUB_PARAMETER Type in your events own sub-parameter that you want its value to be grouped by.

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/eventbreakdowndata?startDate=2024-04-01&typeEvent=level_completed&eventBreakdowns=PowerUp

                                Response: 
                                {
                                    "data": [
                                        {
                                            "eventAmount": 200,
                                            "userAmount": 43,
                                            "Event": "level_completed",
                                            "PowerUp": "Roundhouse"
                                        },
                                        {
                                            "eventAmount": 65,
                                            "userAmount": 14,
                                            "Event": "level_completed",
                                            "PowerUp": "ElbowCombo"
                                        },
                                        {
                                            "eventAmount": 55,
                                            "userAmount": 12,
                                            "Event": "level_completed",
                                            "PowerUp": "GutShot"
                                        },
                                        {
                                            "eventAmount": 21,
                                            "userAmount": 3,
                                            "Event": "level_completed",
                                            "PowerUp": "Slammer"
                                        }
                                    ]
                                }
                                
                                
                            

Example Query #2

                                
                                
                                Aggregators: [{"param": "level", "operator": "AVG"}] 
                                Encoded Aggregators: %5B%7B%22param%22%3A%20%22level%22%2C%20%22operator%22%3A%20%22AVG%22%7D%5D
                                
                                Sub-Param Filter: {"WorldMap": {"operator": "=", "value": "1"}}
                                Encoded Sub-Param Filter: %7B%22WorldMap%22%3A%20%7B%22operator%22%3A%20%22%3D%22%2C%20%22value%22%3A%20%221%22%7D%7D
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/eventbreakdowndata?startDate=2024-04-01&endDate=2024-04-20&typeEvent=level_won&eventBreakdowns=PowerUp,WorldMap,country,buildversion&subParamFilter=%7B%22WorldMap%22%3A%20%7B%22operator%22%3A%20%22%3D%22%2C%20%22value%22%3A%20%221%22%7D%7D&aggregators=%5B%7B%22param%22%3A%20%22level%22%2C%20%22operator%22%3A%20%22AVG%22%7D%5D

                                Response: 
                                {
                                    "data": [
                                        {
                                            "eventAmount": 19,
                                            "userAmount": 4,
                                            "Event": "level_won",
                                            "PowerUp": "Roundhouse",
                                            "WorldMap": "1",
                                            "Country": "US",
                                            "BuildVersion": "0.1.7",
                                            "level_AVG": 5.2105263157894735
                                        },
                                        {
                                            "eventAmount": 14,
                                            "userAmount": 4,
                                            "Event": "level_won",
                                            "PowerUp": "Roundhouse",
                                            "WorldMap": "1",
                                            "Country": "PK",
                                            "BuildVersion": "0.1.7",
                                            "level_AVG": 4.5
                                        },
                                        {
                                            "eventAmount": 12,
                                            "userAmount": 4,
                                            "Event": "level_won",
                                            "PowerUp": "Roundhouse",
                                            "WorldMap": "1",
                                            "Country": "IN",
                                            "BuildVersion": "0.1.7",
                                            "level_AVG": 2.75
                                        }
                                    ]
                                }       
                                
                                
                            

AB Test Data

tag

Using this endpoint in the ALE API, you can get high level details about your games AB Test. More specifically you can use this to retrieve the specfic ab test filter keys to use against the other metric API endpoints.

AB Test Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/abtests

                                Web Game GET Endpoint: https://ale.bytebrew.io/api/webgamedata/abtests

                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
gameId: The Game ID from your account you want to specific AB Tests from.

Example Query #1

                                
                                
                                

                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/abtests

                                Response: 
                                {
                                    "results": [
                                        {
                                            "gameID": gameID1,
                                            "abName": "My AB Test 1",
                                            "abKey": "abtest_1",
                                            "filterKeys": [
                                                "abtest_1:Control Group",
                                                "abtest_1:Group A",
                                                "abtest_1:Group B",
                                            ]
                                        },
                                        {
                                            "gameID": gameID2,
                                            "abName": "Cool AB Test",
                                            "abKey": "cool_abtest",
                                            "filterKeys": [
                                                "cool_abtest:Control Group",
                                                "cool_abtest:Group A",
                                                "cool_abtest:Group B",
                                            ]
                                        }
                                    ]
                                }
                                
                                
                            

Retained User Session Data

tag

Using this endpoint in the ALE API, you can get high level retention session cohort data in your games.

Retained User Session Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionsretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimension to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionsretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "avgSessions": 1.8510638297872344
                                        },
                                        {
                                            "dayCount": 1,
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 3,
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 4,
                                            "avgSessions": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionsretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversion

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "Build": "0.1.7",
                                            "avgSessions": 1.851063829787234
                                        },
                                        {
                                            "dayCount": 1,
                                            "Build": "0.1.7",
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "Build": "0.1.7",
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 3,
                                            "Build": "0.1.7",
                                            "avgSessions": 1
                                        },
                                        {
                                            "dayCount": 4,
                                            "Build": "0.1.7",
                                            "avgSessions": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }     
                                
                                
                            

Retained User Ads Data

tag

Using this endpoint in the ALE API, you can get high level retention ads cohort data in your games.

Retained User Ads Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/adsretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimension to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/adsretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "avgAds": 3.357142857142857
                                        },
                                        {
                                            "dayCount": 1,
                                            "avgAds": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "avgAds": 2
                                        },
                                        {
                                            "dayCount": 3,
                                            "avgAds": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/adsretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversions

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "Build": "0.1.7",
                                            "avgAds": 3.357142857142857
                                        },
                                        {
                                            "dayCount": 1,
                                            "Build": "0.1.7",
                                            "avgAds": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "Build": "0.1.7",
                                            "avgAds": 2
                                        },
                                        {
                                            "dayCount": 3,
                                            "Build": "0.1.7",
                                            "avgAds": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }  
                                
                                
                            

Retained User Purchase Data

tag

Using this endpoint in the ALE API, you can get high level retention purchase cohort data in your games.

Retained User Purchase Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasesretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimension to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasesretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "avgPurchases": 3.357142857142857
                                        },
                                        {
                                            "dayCount": 1,
                                            "avgPurchases": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "avgPurchases": 2
                                        },
                                        {
                                            "dayCount": 3,
                                            "avgPurchases": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/purchasesretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversions

                                Response: 
                                {
                                    "data": [
                                        {
                                            "dayCount": 0,
                                            "Build": "0.1.7",
                                            "avgPurchases": 3.357142857142857
                                        },
                                        {
                                            "dayCount": 1,
                                            "Build": "0.1.7",
                                            "avgPurchases": 1
                                        },
                                        {
                                            "dayCount": 2,
                                            "Build": "0.1.7",
                                            "avgPurchases": 2
                                        },
                                        {
                                            "dayCount": 3,
                                            "Build": "0.1.7",
                                            "avgPurchases": 1
                                        }
                                    ],
                                    "type": "DAY"
                                }  
                                
                                
                            

Retained User Session Length Data

tag

Using this endpoint in the ALE API, you can get high level retention session length data in your games.

Retained User Session Length Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlengthretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimension to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlengthretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-16",
                                            "day_0_sessions": 64,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-17",
                                            "day_0_sessions": 812,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-18",
                                            "day_0_sessions": 83.33333333333333,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-19",
                                            "day_0_sessions": 20.5,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/sessionlengthretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversions

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-16",
                                            "Build": "0.1.7",
                                            "day_0_sessions": 64,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-17",
                                            "Build": "0.1.7",
                                            "day_0_sessions": 812,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-18",
                                            "Build": "0.1.7",
                                            "day_0_sessions": 83.33333333333333,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        },
                                        {
                                            "install_date": "2024-07-19",
                                            "Build": "0.1.7",
                                            "day_0_sessions": 20.5,
                                            "day_1_sessions": 0,
                                            "day_2_sessions": 0,
                                            "day_3_sessions": 0,
                                            "day_4_sessions": 0,
                                            "day_5_sessions": 0,
                                            "day_6_sessions": 0,
                                            "day_7_sessions": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Retained User Playtime Data

tag

Using this endpoint in the ALE API, you can get high level retention playtime data in your games.

Retained User Playtime Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtimeretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimension to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtimeretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-16",
                                            "day_0_playtime": 64,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-17",
                                            "day_0_playtime": 955,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-18",
                                            "day_0_playtime": 83.33333333333333,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-19",
                                            "day_0_playtime": 41,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/playtimeretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversions

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-16",
                                            "Build": "0.1.7",
                                            "day_0_playtime": 64,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-17",
                                            "Build": "0.1.7",
                                            "day_0_playtime": 955,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-18",
                                            "Build": "0.1.7",
                                            "day_0_playtime": 83.33333333333333,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        },
                                        {
                                            "install_date": "2024-07-19",
                                            "Build": "0.1.7",
                                            "day_0_playtime": 41,
                                            "day_1_playtime": 0,
                                            "day_2_playtime": 0,
                                            "day_3_playtime": 0,
                                            "day_4_playtime": 0,
                                            "day_5_playtime": 0,
                                            "day_6_playtime": 0,
                                            "day_7_playtime": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Retained User Cumulative Playtime Data

tag

Using this endpoint in the ALE API, you can get high level retained cumulative playtime data in your games.

Retained User Cumulative Playtime Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/cumulativeplaytimeretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
groupBy: Optionial dimensions to define to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/cumulativeplaytimeretained?startDate=2024-07-17&scaleType=Days

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 0,
                                            "retained_cumulativeplaytime": 155
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 1,
                                            "retained_cumulativeplaytime": 363
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 2,
                                            "retained_cumulativeplaytime": 535
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 3,
                                            "retained_cumulativeplaytime": 3081
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 4,
                                            "retained_cumulativeplaytime": 6313
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 5,
                                            "retained_cumulativeplaytime": 14432
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/cumulativeplaytimeretained?startDate=2024-07-17&scaleType=Days&groupBy=buildversions

                                Response: 
                                {
                                    "data": [
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 0,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 155
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 1,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 363
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 2,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 535
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 3,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 3081
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 4,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 6313
                                        },
                                        {
                                            "install_date": "2024-07-20",
                                            "day_number": 5,
                                            "Build": "0.1.7",
                                            "retained_cumulativeplaytime": 14432
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Retained User Custom Event Data

tag

Using this endpoint in the ALE API, you can get custom event data by retained days in your games.

Retained User Custom Event Data Endpoint

                                
                                

                                Mobile Game GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/targeteventsretained
                                
                                
                            

Attach Parameters

To define the data you want to request using the this endpoint, you can utilize the following parameters in your query:

fiber_manual_record
(Required) startDate: Start Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-01"
fiber_manual_record
endDate: End Date for the query. Use the following format: "YYYY-MM-DD" ex. "2021-03-30"
fiber_manual_record
(Required) gameId: The Game ID from your account you want to query. In this field you must give one Game ID due to the expansive nature of custom events.
fiber_manual_record
scaleType: The retention scale (Days, Weeks, Months) that you want your results by. If left empty or ommited, the system default to Days.
fiber_manual_record
scaledAmount: The retention periods amounts you want back, check the below bullet points for the amounts accepted.
fiber_manual_record
Day Amount Options (select one): 7, 14, 28, 30, 60, 90, 180, 365
fiber_manual_record
Week Amount Options (select one): 4, 8, 16, 24, 32, 46, 52
fiber_manual_record
Month Amount Options (select one): 2, 4, 6, 8, 12, 18
fiber_manual_record
abtests: The abtest keys you want to search for, ex. "abtest1:Group B". In this field, you have the option to give: (1) an array of abtest keys you want to filter or (2) leave the field empty.
fiber_manual_record
country: The countries you want the data filtered by. In this field, you have the option to give: (1) an array of country codes you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all counties.
fiber_manual_record
build: The build versions you want the data filtered by. In this field, you have the option to give: (1) an array of build versions you want to filter or (2) leave the field empty. If left empty or ommited, the system will auto include data from all builds.
fiber_manual_record
aggregate: A JSON that contains all information on how you want to aggregate your event data, if empty it will default to count of the event. Make sure you Encode the JSON before sending to the API.
fiber_manual_record
aggregate: Set the type of aggregate you want to use, "unique" | "avg" | "uniquepercent".
fiber_manual_record
param: When using the aggregate type, "sub-param", set the sub-parameter you want the aggregate operator to target.
fiber_manual_record
operator: Pick one of the following operators for it to use on the sub-parameter - 'AVG', 'MEDIAN', 'SUM', 'MIN', 'MAX'
                                                

                                                1. Basic Event Aggregators
                                                {"aggregate": "unique" | "avg" | "uniquepercent"}
                                                
                                                2. Sub-param Aggregator
                                                {"aggregate": "sub-param", "param": "YOUR_SUB_PARAMETER", "operator": "AVG" | "MEDIAN" | "SUM" | "MIN" | "MAX" }

                                                
                                            
fiber_manual_record
subParamFilter: A dictionary with each key is a sub-parameter and its value is a nested JSON filter. Make sure you Encode the JSON dictionary before sending to the API.
fiber_manual_record
operator: Pick one of the following operators - '=', '!=', '>=', '>', '<', '<='
fiber_manual_record
value: Set the value you want to compare and query for.
                                                
                                                { "SUB_PARAMETER": { "operator": "=" | "!=" | ">=" | ">" | "<" | "<=", "value": "VALUE" } }

                                                Example Sub-Param Filter:
                                                { "level": { "operator": "=", "value": "5" }, "character": { "operator": "=", "value": "Viking" } }
                
                
                                                
                                                
                                            
fiber_manual_record
(Required) groupBy: Optionial dimensions to breakdown your data by. This is optional and can be left empty or ommited. See list of available breakdowns:
fiber_manual_record
Date
fiber_manual_record
BuildVersion

Example Query #1

                                
                                
                                
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/targeteventsretained?startDate=2024-07-17&scaleType=Days&targetEvent=level_won&groupBy=Date

                                Response: 
                                {
                                    "breakdown": "Date",
                                    "data": [
                                        {
                                            "Date": "2024-08-11",
                                            "day_0": 5,
                                            "users_0": 2,
                                            "day_1": 0,
                                            "users_1": 0,
                                            "day_2": 0,
                                            "users_2": 0,
                                            "day_3": 0,
                                            "users_3": 0,
                                            "day_4": 0,
                                            "users_4": 0,
                                            "day_5": 0,
                                            "users_5": 0,
                                            "day_6": 0,
                                            "users_6": 0,
                                            "day_7": 0,
                                            "users_7": 0
                                        },
                                        {
                                            "Date": "2024-08-12",
                                            "day_0": 10,
                                            "users_0": 2,
                                            "day_1": 12,
                                            "users_1": 2,
                                            "day_2": 0,
                                            "users_2": 0,
                                            "day_3": 0,
                                            "users_3": 0,
                                            "day_4": 0,
                                            "users_4": 0,
                                            "day_5": 0,
                                            "users_5": 0,
                                            "day_6": 0,
                                            "users_6": 0,
                                            "day_7": 0,
                                            "users_7": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Example Query #2

                                
                                
                                    Aggregators: {"aggregate":"sub-param", "param": "points", "operator": "max"}
                                    Encoded Aggregators: %7B%22aggregate%22%3A%22sub-param%22%2C%20%22param%22%3A%20%22points%22%2C%20%22operator%22%3A%20%22max%22%7D
                                    
                                    Sub-Param Filter: {"level": {"operator": ">", "value": "2"}}
                                    Encoded Sub-Param Filter: %7B%22level%22%3A%20%7B%22operator%22%3A%20%22%3E%22%2C%20%22value%22%3A%20%222%22%7D%7D
                                
                                    
                                GET Endpoint: https://ale.bytebrew.io/api/gamedata/analytics/targeteventsretained?startDate=2024-07-17&scaleType=Days&targetEvent=level_won&groupBy=BuildVersion&aggregate=%7B%22aggregate%22%3A%22sub-param%22%2C%20%22param%22%3A%20%22points%22%2C%20%22operator%22%3A%20%22max%22%7D&subParamFilter=%7B%22level%22%3A%20%7B%22operator%22%3A%20%22%3E%22%2C%20%22value%22%3A%20%222%22%7D%7D

                                Response: 
                                {
                                    "breakdown": "BuildVersion",
                                    "data": [
                                        {
                                            "Build": "0.1.7",
                                            "day_0": 8,
                                            "users_0": 7,
                                            "day_1": 0,
                                            "users_1": 0,
                                            "day_2": 0,
                                            "users_2": 0,
                                            "day_3": 0,
                                            "users_3": 0,
                                            "day_4": 0,
                                            "users_4": 0,
                                            "day_5": 0,
                                            "users_5": 0,
                                            "day_6": 0,
                                            "users_6": 0,
                                            "day_7": 0,
                                            "users_7": 0
                                        }
                                    ],
                                    "scale": "DAY"
                                }
                                
                                
                            

Breaking Down By Game

tag

Using the game breakdown value, expect a response with an additional field "metadata" that is alongside "data".

Breaking Down By Game Response Example

                                
                                

                                    Response: 
                                    {
                                        "data": [
                                            {
                                                "Users": 421,
                                                "Game": "GameID1"
                                            },
                                            {
                                                "Users": 140,
                                                "Event": "GameID2"
                                            }
                                        ],
                                        "metadata": {
                                            "games": [
                                                {
                                                    "gameID": "gameID1",
                                                    "platform": "Android",
                                                    "bundleID": "com.example.gameID1"
                                                },
                                                {
                                                    "gameID": "gameID2",
                                                    "platform": "iOS",
                                                    "bundleID": "com.example.gameID2"
                                                }
                                            ]
                                        }
                                    }