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

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

404

Error Application instance not found

500

Internal Server Error

application/json

get

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

GET /v3/telemetry/applicationInstance/{applicationInstanceId}/memory HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

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

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

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

404

Error Application instance not found

500

Internal Server Error

application/json

get

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

GET /v3/telemetry/applicationInstance/{applicationInstanceId}/cpu HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

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

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

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

minute
hour
day
week

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/providerId

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "applicationInstances": [
          {
            "providerId": 1,
            "applicationInstanceCount": 1
          }
        ]
      }
    ]
  }
]

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

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

minute
hour
day
week

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/providerId/aggregate

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "applicationInstances": [
          {
            "providerId": 1,
            "applicationInstanceCount": 1
          }
        ]
      }
    ]
  }
]

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

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

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/deploymentProfile/status

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "deploymentProfiles": [
          {
            "deploymentProfileId": "text",
            "setup": 1,
            "offline": 1,
            "starting": 1,
            "online": 1,
            "allocated": 1,
            "deploymentRegions": [
              {
                "deploymentRegionId": "text",
                "setup": 1,
                "offline": 1,
                "starting": 1,
                "online": 1,
                "allocated": 1
              }
            ]
          }
        ]
      }
    ]
  }
]

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

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

minute
hour
day
week

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/status

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "setup": 1,
        "offline": 1,
        "starting": 1,
        "online": 1,
        "allocated": 1
      }
    ]
  }
]

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

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

minute
hour
day
week

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/status/aggregate

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "setup": 1,
        "offline": 1,
        "starting": 1,
        "online": 1,
        "allocated": 1
      }
    ]
  }
]

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

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

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

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/distribution/current

GET /v3/telemetry/applicationInstance/distribution/current HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "bareMetal": 1,
    "bareMetalPercentage": 1,
    "flexMetal": 1,
    "flexMetalPercentage": 1,
    "cloud": 1,
    "cloudPercentage": 1,
    "total": 1
  }
]

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

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/applicationInstance/distribution

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "bareMetal": 1,
        "bareMetalPercentage": 1,
        "flexMetal": 1,
        "flexMetalPercentage": 1,
        "cloud": 1,
        "cloudPercentage": 1,
        "total": 1
      }
    ]
  }
]

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

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

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

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/hostCapacity/current

GET /v3/telemetry/applicationInstance/hostCapacity/current HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "bareMetal": 1,
    "flexMetal": 1,
    "cloud": 1
  }
]

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

application/json

unitstringRead-onlyRequired

Unit of data frequency

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/applicationInstance/crash

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

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

Last updated 11 months ago

Was this helpful?