CCUTelemetry

CCU telemetry requests

Get the concurrent connected users telemetry for the current point in time

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId
• deploymentRegionId
• dcLocationId

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/telemetry/ccu/status

GET /v3/telemetry/ccu/status HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "maxPlayers": 1,
        "currentPlayers": 1
      }
    ]
  }
]

Get the telemetry of aggregated average of concurrent connected users

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId
• deploymentRegionId
• dcLocationId

startTimeintegerOptional

Unix timestamp. Filter from time, default value is -1 day

endTimeintegerOptional

Unix timestamp. Filter to time, default value is now

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

• minute
• hour
• day
• month

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/telemetry/ccu/status/aggregate

GET /v3/telemetry/ccu/status/aggregate HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "ccus": [
          {
            "providerId": 1,
            "maxPlayers": 1,
            "currentPlayers": 1
          }
        ]
      }
    ]
  }
]

Count of players for an application

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

applicationIdstringRead-onlyRequired

Application ID

applicationNamestringRequired

The public name of your application

playerCountinteger · integerRead-onlyRequired

Number of players currently playing on the hosts

maxPlayersinteger · integerRead-onlyRequired

Maximum number of players the hosts can support

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/telemetry/ccu/application

GET /v3/telemetry/ccu/application HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "applicationId": "text",
    "applicationName": "text",
    "playerCount": 1,
    "maxPlayers": 1
  }
]