Reporting API

The Reporting API is used to stream large reports and collected data for further analysis.

Click the download button in the interface to download a report. Reports can be extremely large and the total size of the report is not known because it streamed directly out of the database.

To download a report via API use the following endpoints:

Display Report

Custom date ranges can be specified using startMillis and endMillis parameters. (Milliseconds since the epoc)

A report for a specific screen, sequence, stack item or library item can be downloaded by setting type and id parameters.

Set type to screen, sequence, item or libraryitem as required.

Display Summary

Set aggregation to screen, item or screen_and_item as required.

Collected Data Report

The fields in the CSV can be selected by including a parameter named fields populated with a comma separated list of field names.

Custom data can be fetched from referenced library items, sequences and screens by prefixing the name with libraryItem. sequence. or screen..

For example, to include itemId, screenId and the custom field myCustomField stored in the screen data, the following parameter can be added to the request:

?fields=itemId,screenId,screen.myCustomField