API Stream Analytics

You can use the API Stream Analytics page to build custom queries against:

The API Stream page is designed to allow you to quickly build a query for the API data you want to review and analyze:

There are some constraints for this Analytics tool:

You can also use the API Stream to identify requests your game is making into the platform that are proving performance-costly:

In this topic, we'll give examples to show:

Example for Connection Requests API Stream Analytics Data

In this example, we pull API Stream analytics data for connection request calls into the platform:

1. Open the Analytics > API Stream page.

2. Build a query for each of the different types of connection request API calls into the platform your game has made:

Building your Query! There are two things to note when you add rules to build your query. Firstly, the drop-down for the request or message you select to query for will be divided into In Use and Other - the In Use requests/messages are those that are currently "live" in the API Stream; those listed under Other are the requests/messages that are not currently live. Secondly, you can refine your query rule by adding a Filter on the rule.

3. Click Update. The current API Stream is queried and the data are returned and displayed:

4. You can read-off data from the charts:

Data Delay! When you query the API Stream, the data used to build the charts and display the query results will not be right up to date. This is because there is a slight delay of approximately ten minutes before the data for the request or message activity being queried becomes available to build the charts.

Using API Stream Data to Identify Performance Issues

You can use the API Stream Analytics tool as a starting point for investigating and addressing any calls your game is making into the platform that are proving performance-costly:

To check the performance of requests your game is making into the platform:

1. Open the Analytics > API Stream page.

2. Click to Delete the default empty query.

3. For configuring the returned data:

4. Click to Update API Stream data.

5. On the Histogram chart, you can quickly identify those calls into the platform that are taking longest to process:

Did this page help you? Please enter your feedback below. For questions about using this part of the platform, please contact support here