User Manual

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

/api/display-report/full.csv

This will download the report of items displayed in the last 24 hours. Reporting must be enabled for each item individually to appear in the report.

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

/api/display-report/full.csv?startMillis=1388534400000

This will download a report containing all items displayed since January 2014.

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

/api/display-report/full.csv?startMillis=1388534400000&type=screen&id=1234567ABCDEF

This will download a report containing all items displayed on the screen with ID/MAC 1234567ABCDEF since January 2014.

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

Display Summary

/api/display-summary/full.csv?aggregation=item

This will download the display counts for items displayed in the last 24 hours grouped by item.

Set aggregation to screen, item or screen_and_item as required.

Collected Data Report

/api/collected-data-report/full.csv

This will download the report of collected data in the last 24 hours. The collect data event must be set for each item individually and data must be entered by the user to appear in the 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