Sends data requests and retrieves game event data, such as event names and occurrences, from the Xbox One console.
Data requests are made automatically from set time intervals. These data requests are sent through the web socket as a stringified JSON.
This JSON has the following format:
option-name: The name of data request option
Data request options:
all-events: Requests data for all existing game events recorded on the Xbox console over the last 30 minutes. This call is used to populate the game event data table, and the call is made at 30 second intervals.
event-count: Requests the current game event count recorded on the Xbox console. This call is used to populate data points on the game event chart, and the call is made at 5 second intervals.
event-collection-interval: Requests the time interval, in seconds, that dictacte how long game events are stored on the Xbox console at any given time.
event-count-limit: Requests the game event count limit value. This call is made once at page load time.
toast-frequency: Requests the time interval, in seconds, that dictates the frequency that the event limit toast notification alert can be triggered on the Xbox console.
For the five data request options above, the web socket will return a JSON object.
This JSON has the following format:
option-name: The name of data request option
data-available: A boolean value that is true when data was retrieved, and false otherwise.
game-title: Holds the game title id for the current game running on the Xbox console. This field is only available to the "all-events" data request option.
data: This field holds different types of data depending on the data requested.
- all-events option: This field holds a JSON that hold keys that are game event names (strings) and values that are the corresponding occurrences of the game event (integer).
- event-count: Holds a JSON with a single field, "count", that maps to the current event count (integer).
- event-collection-interval: Holds a JSON with a single field, "interval", that maps to the event collection interval time in seconds (integer).
- event-count-limit: Holds a JSON with a single field, "limit", that maps to the event count limit value (integer).
- toast-frequency: Holds a JSON with a single field, "frequency", that maps to the event limit toast notification frequency time in seconds (integer).