Introduction

Exit Games analytics service backend API description. Mail our developers if you have questions. The analytics API is a HTTP service, that allows you to get metrics about your Photon Cloud application data and Photon Server license usage. See the API reference for available endpoints.

Parameter Descriptions

Common API Parameters

These are used across vaious requests.
Parameter Type Description 
appid
 string ID of the application counter data are queried for. Get it from your Photon Cloud dashboard. 
hash
 string Hash for the license counter data are queried for. Get it from your Photon Server dashboard. 
region
 string The region token for the queried region. Find available region tokens in the regions doc 
{parameters}
 URL parameters string Optional query string parameters (see below).

Optional Query String Parameters

Optional parameters to refine your API request.
Parameter Type Description 
start
 string

The point in time queried data start at, pass as UTC timestamp: YYYY-MM-DD[Thh:mm:ss].
Omitting the optional part - [Thh:mm:ss] - will automatically start the query at  0AM UTC for the passed date.

Passing no start time at all will query data for the last 24 hours.

 
end
 string The point in time queried data end at.
Omitted, queried data end "now". 		 
width
 number

Images requests only. Width in pixels, pass 1600 max - returns an error for higher numbers.

 
height
 number

Images requests only. Height in pixels, pass 1600 max - returns an error for higher numbers.

Photon Cloud Applications

Available Counters

Counter Name Description 
TrafficMultiplayer
 Total of incoming and outgoing traffic on your raltime app in bytes (average). 
TrafficChat
 Total of incoming and outgoing traffic on your chat app in bytes (maximum). 
Rooms
 Amount of simultaneously open rooms (maximum). 
Channels
 Amount of simultaneously open channels (maximum). 
Messages
 Amount of messages per second across all games open (maximum). 
Ccu
 The CCU count for your application, aggregating room and lobby user counts (maximum). 
Rejects
 Number of players rejected for CCU exceeding your plan (maximum). 
DisconnectRate
 Amount of non-client-requested disconnects per second per 1000 players (maximum). 
MessagesPerRoom
 Amount of messages per second per room (maximum). 
MessagesPerChannel
 Amount of messages per second per channel (maximum). 
MessagesPerCcu
 Amount of messages per second per ccu (maximum).

Bulk Data Request /bulkdata/app

Sample

For each query description (each id) you set up in the request, you will get an entry in the response mapped to the respective id.
Request Response 
[
  {
    "id": "europe",      
    "appid": "5e1fb724-7139-4b96-aa67-9d4c37b27bb0",
    "cloud": "public",
    "cluster": "default",
    "region": "eu",
    "template": "Ccu"
  },
  {
    "id": "usa",      
    "appid": "e83b9029-cc93-4d1c-a9c4-9bbc73ea1f68",
    "cloud": "public",
    "cluster": "default",
    "region": "us",
    "template": "Ccu"
  }
]
 
{
  "europe": 0,
  "usa": 3748.37
}

Bulk Xport Request /bulkxport/app

Sample

For each query description (each id) you set up in the request, you will get an entry in the response mapped to the respective id.
Request Response 
[
  {
    "id": "europe",      
    "appid": "5e1fb724-7139-4b96-aa67-9d4c37b27bb0",
    "cloud": "public",
    "cluster": "default",
    "region": "eu",
    "template": "Ccu"
  },
  {
    "id": "usa",      
    "appid": "e83b9029-cc93-4d1c-a9c4-9bbc73ea1f68",
    "cloud": "public",
    "cluster": "default",
    "region": "us",
    "template": "Ccu",
    "xporttime": "time"
  }
]
 
{
  "europe": {
    "ds2": [
      11722,
      12242,
      12818,
      13020,
      ...        
    ]
  },
  "usa": {
    "ds2": [
      1934,
      7802,
      8144,
      8897,
      ...
    ],
    "time": [
      1.4987268e+09,
      1.4987286e+09,
      1.4987304e+09,
      1.4987322e+09,
      ...
    ]
  }
}

Bulk Data and Xport Request /bulk/app

Sample

For each query description (each id) you set up in the request, you will get an entry in the response mapped to the respective id.
Request Response 
[
  {
    "id": "europe",      
    "appid": "5e1fb724-7139-4b96-aa67-9d4c37b27bb0",
    "cloud": "public",
    "cluster": "default",
    "region": "eu",
    "template": "Ccu"
  },
  {
    "id": "usa",      
    "appid": "e83b9029-cc93-4d1c-a9c4-9bbc73ea1f68",
    "cloud": "public",
    "cluster": "default",
    "region": "us",
    "template": "Ccu",
    "xporttime": "time"
  }
]
 
{
  "europe": {
    "data": 18622,
    "xport": {
      "ds2": [
        11722,
        12242,
        12818,
        13020,
        ...        
      ]
    }
  },
  "usa": {
    "data": 15285,
    "xport": {
      "ds2": [
        1934,
        7802,
        8144,
        8897,
        ...
      ],
      "time": [
        1.4987268e+09,
        1.4987286e+09,
        1.4987304e+09,
        1.4987322e+09,
        ...
      ]
    }
  }
}

Photon Server Licenses

Available Counters

Counter Name Description 
Servers
 Number of instances running, each instance made up by a single hardware ID. 
CCU
 Number of CCU connected to the license in total.

Bulk Data Request /bulkdata/license

Sample

For each query description (each id) you set up in the request, you will get an entry in the response mapped to the respective id.
Request Response 
[
  {
    "id": "ccu",
    "hash": "0xc648c47f82c70b723f0225e12b8ce4f2",
    "template": "Ccu"
  },
  {
    "id": "servers",
    "hash": "0xc648c47f82c70b723f0225e12b8ce4f2",
    "template": "Servers"
  }
]
 
{
  "ccu": 765,
  "servers": 3
}