ApplicationInstanceTelemetry

Game server telemetry requests

Get memory telemetry data for the given application instance (default = last 24 hours)

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationInstanceIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency, which is always null in this endpoint. This property is there for consistency across all telemetry endpoints. It's null because the data is not aggregated

get
/v3/telemetry/applicationInstance/{applicationInstanceId}/memory

Get cpu telemetry data for the given application instance (default = last 24 hours)

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationInstanceIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency, which is always null in this endpoint. This property is there for consistency across all telemetry endpoints. It's null because the data is not aggregated

get
/v3/telemetry/applicationInstance/{applicationInstanceId}/cpu

Get how many application instances are currently deployed by providerId

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, possible interval options are as follows

  • minute
  • hour
  • day
  • week
get
/v3/telemetry/applicationInstance/providerId

Get the aggregated list of application instance by providerId

get

Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows

  • minute

  • hour

  • day

  • month

Authorizations
PRIVATE-TOKENstringRequired
Query parameters
typestringOptional
  • 0: Both game and utilities
  • 1: Only game (default)
  • 2: Only utilities
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
  • week
get
/v3/telemetry/applicationInstance/providerId/aggregate

Get live status of application instances grouped by deployment profile

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
typestringOptional
  • 0: Both game and utilities
  • 1: Only game (default)
  • 2: Only utilities
filterstringOptional

You can filter based on the following parameters

  • deploymentProfileId
Responses
200

OK

application/json
unitstring · nullableRead-onlyRequired

Unit of data frequency, which is always null in this endpoint. This property is there for consistency across all telemetry endpoints. It's null because the data is not aggregated

get
/v3/telemetry/applicationInstance/deploymentProfile/status

Get live status of application instances

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
typestringOptional
  • 0: Both game and utilities
  • 1: Only game (default)
  • 2: Only utilities
filterstringOptional

You can filter based on the following parameters

  • deploymentEnvironmentId
  • fleetId
  • deploymentRegionId
  • dcLocationId
Responses
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

  • minute
  • hour
  • day
  • week
get
/v3/telemetry/applicationInstance/status

Get the aggregated list of application instances status

get

Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows

  • minute

  • hour

  • day

  • month

Authorizations
PRIVATE-TOKENstringRequired
Query parameters
typestringOptional
  • 0: Both game and utilities
  • 1: Only game (default)
  • 2: Only utilities
filterstringOptional

You can filter based on following parameters

  • deploymentEnvironmentId
  • fleetId
  • regionId
  • 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
  • week
get
/v3/telemetry/applicationInstance/status/aggregate

Get the current distribution of application instances (of type Game) for bare metal, flex metal and cloud

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
200

OK

application/json
bareMetalinteger · integerRead-onlyRequired

Amount of game instances on the bare metal

bareMetalPercentageinteger · integerRead-onlyRequired

Percentage of game instances on the bare metal

flexMetalinteger · integerRead-onlyRequired

Amount of game instances on the flex metal

flexMetalPercentageinteger · integerRead-onlyRequired

Percentage of game instances on the flex metal

cloudinteger · integerRead-onlyRequired

Amount of game instances in the cloud

cloudPercentageinteger · integerRead-onlyRequired

Percentage of game instances in the cloud

totalinteger · integerRead-onlyRequired

Total amount of game instances

get
/v3/telemetry/applicationInstance/distribution/current

Get the historic distribution of application instances (of type Game) for bare metal, flex metal and cloud

get

Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows

  • minute

  • hour

  • day

Authorizations
PRIVATE-TOKENstringRequired
Query parameters
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
get
/v3/telemetry/applicationInstance/distribution

Get the aggregated list of application instances (of type Game) for bare metal, flex metal and cloud

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
200

OK

application/json
bareMetalinteger · integerRead-onlyRequired

Percentage of game instances on the bare metal, based on the amount set in the host capacity template

flexMetalinteger · integerRead-onlyRequired

Percentage of game instances on the flex metal, based on the amount set in the host capacity template

cloudinteger · integerRead-onlyRequired

Percentage of game instances in the cloud, based on the amount set in the host capacity template

get
/v3/telemetry/applicationInstance/hostCapacity/current

Count of crashes within a given time period for all application instances

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
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

get
/v3/telemetry/applicationInstance/crash

Last updated

Was this helpful?