Analytics Game Telemetry Events 0.1.0 documentation

Published Messages (telemetry)

The service publishes one of these messages below.

analyticsHeartbeat

This event serves as a heartbeat for monitoring analytics service. This event is part of game-telemetry, not event. Contains fields from telemetryBody and the following payload.

Example value

{
  "Payload": {},
  "EventId": "string",
  "EventNamespace": "string",
  "EventTimestamp": "2019-08-24T14:15:22Z",
  "EventName": "string",
  "UserId": "string",
  "UserNamespace": "string",
  "ClientId": "string",
  "ClientTimestamp": "2019-08-24T14:15:22Z"
}

Payload

This is a free-form object.

realmoneyTransaction

This event is triggered when the user sends a real-money transaction via game-telemetry API. Contains fields from telemetryBody and the following payload.

Example value

{
  "Payload": {
    "userId": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "platform": {
      "name": "PlayStation",
      "userId": "string"
    },
    "type": "string",
    "amount": 0,
    "currencyCode": "string",
    "items": [
      {}
    ]
  },
  "EventId": "string",
  "EventNamespace": "string",
  "EventTimestamp": "2019-08-24T14:15:22Z",
  "EventName": "string",
  "UserId": "string",
  "UserNamespace": "string",
  "ClientId": "string",
  "ClientTimestamp": "2019-08-24T14:15:22Z"
}

Payload

Name	Type	Description
userId	string	-
timestamp	string (date-time)	-
platform	object	-
type	string	-
amount	number	-
currencyCode	string	-
items	array<object>	-

payload.platform

Name	Type	Description
name	string	-
userId	string	-

payload.items[number]

This is a free-form object.

enhancedPresence

Presence event sent through telemetry. Contains fields from telemetryBody and the following payload.

Example value

{
  "Payload": {
    "flight_id": "string",
    "platform_name": "string",
    "game_state": "string",
    "game_context": "string"
  },
  "EventId": "string",
  "EventNamespace": "string",
  "EventTimestamp": "2019-08-24T14:15:22Z",
  "EventName": "string",
  "UserId": "string",
  "UserNamespace": "string",
  "ClientId": "string",
  "ClientTimestamp": "2019-08-24T14:15:22Z"
}

Payload

Name	Type	Description
flight_id	string	-
platform_name	string	-
game_state	string	-
game_context	string	-

Schemas

telemetryBody

Name	Type	Description
EventId	string	Unique ID (UUID) of the telemetry event
EventNamespace	string	Namespace of the telemetry event. Not strictly checked against AGS namespace.
EventTimestamp	string (date-time)	Timestamp of the event which is added in the server side, has a possibility that this is not the true timestamp because the event usually is batched in the SDK side before being sent to the server
EventName	string	The name of the event.
UserId	string	AGS User ID of the user who sent the telemetry. Null if telemetry is sent by a server using OAuth Client Credential
UserNamespace	string	AGS Namespace of the user who sent the telemetry. Null if telemetry is sent by a server using OAuth Client Credential
ClientId	string	If the event is sent by a user, this field is the ID of the OAuth Client which is used to authenticate this user. If the event is a server using an OAuth Client Credential, this field is the ID of that OAuth Client.
ClientTimestamp	string (date-time)	Timestamp of the event, which is added by the game SDK. This is the true timestamp of the event.