ALE API Documentation

ByteBrew offers a Pull API which gives access to cohort overview data in key areas of your games data. You can get access to the ALE API by utilizing your Studios API key. Get access to the Dashboard


ALE Authentication

free_breakfast Before you start: Make sure to have a email that is Admin in your studio and the studio api key.

1: Authenticate by retrieving a token.

Send a POST request to get a temporary 1 hour api token.

The request must have a JSON body containing the following:

- email
- apiKey
  
  // Request Link
  POST: https://ale.bytebrew.io/auth/generatetoken
  Body Data: 
  {
      "email": "someones@email.com",
      "apiKey": "AVERYLONGSCRAMBLEOFASCIICHARACTERSGIVENBYTIMTHEMAGICIAN"
  }
  
                    

The request will return a response containing the "token"


    {
        "token": "AEVENLONGERSCRAMBLEOFASCIICHARACTERSGIVENBYTIMTHEMAGICIAN"
    }

                  
Every request for api data needs to have a Authorization Header:

    Authorization: Bearer AEVENLONGERSCRAMBLEOFASCIICHARACTERSGIVENBYTIMTHEMAGICIAN

                  

User Data

Get high level cohort data about your trends of users.

1: User Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • BuildVersion
  • OSVersion
  • Country
  • Device
  • 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"
            }    
        ]
    }

                  

Progression Data

Get high level cohort data about your progression trends.

1: Progression Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • ProgressionType
  • Environment
  • Stage
  • BuildVersion
  • OSVersion
  • Country
  • Device
  • 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

Get high level cohort data about your revenue broken down by monetized ad revenue and purchase revenue.

1: Monetization Revenue Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • Country
  • 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

Get high level cohort data about your purchase revenue.

1: Monetization Purchase Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • Country
  • Platform
  • Item
  • Category
  • Country
  • Device
  • BuildVersion
  • OSVersion

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"
          }
      ]
    }

                  

Monetization Ad Revenue Data

Get high level cohort data about your ad revenue.

1: Monetization Ad Revenue Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • Country
  • Platform
  • Network
  • AdType
  • AdUnit
  • 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

Get high level cohort data about your custom events.

1: Custom Event Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- aggregator: empty or value of how you want to aggregate the events.
  • MeanCount
  • MeanValue
  • ValueSum
  • Count
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • Country
  • BuildVersion
  • OSVersion
  • Device
  • Event
  • 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"
          }
      ]
    }

                  

Attribution Data

Get high level cohort data about your attribution.

1: Attribution Data Endpoint.

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


                  
Attach Parameters

To further dive into the data, you can specify multiple parameters in the query.

priority_highImportant: All queries in User Data must have a start date set.

The request can have the following parameters:

- (Required) startDate: Format "YYYY-MM-DD" ex. "2021-03-01"
- endDate: Format "YYYY-MM-DD" ex. "2021-03-30"
- gameId: empty or an array of gameIds to query, if ommited will resort to your studios games
- country: empty or an array of countries to filter by, if ommited will resort to all
- platform: empty or an array of either "iOS" or "Android" to filter by, if ommited will resort to all
- breakdown: empty or an array, check the below breakdowns
  • Game
  • Date
  • Country
  • Network
  • Campaign
  • AdSet
  • Creative

Example Query 1:


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

    Response: 
    {
      "data": [
          {
              "installs": 113,
              "clicks": 54001,
              "views": 348912,
              "spend": 1204.21
          }
      ]
    }

                  

Example Query 2:


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

    Response: 
    {
      "data": [
          {
              "installs": 0,
              "clicks": 39,
              "views": 15,
              "spend": 7.31,
              "Network": "CrossInstall",
              "Campaign": "Test Campaign - Android"
          },
          {
              "installs": 0,
              "clicks": 15,
              "views": 23,
              "spend": 12.42,
              "Network": "CrossInstall",
              "Campaign": "Test Campaign 2 - iOS"
          },
          {
              "installs": 11,
              "clicks": 53947,
              "views": 0,
              "spend": 160.5,
              "Network": "TapJoy",
              "Campaign": "Video - Android - US -- tracking for video button"
          }
      ]
    }