Overview

Every Serverside.ai setup includes a set of built-in reports, which are described in this document. To create additional reports, reach out to our Professional Services team for assistance.

Key concepts: systems and reports

Before using the Reports API, it is important to understand the concepts of systems and reports and how they relate to each other.

Systems

A Serverside.ai instance can include multiple systems. These systems are typically links to external APIs or applications that extend the functionality of Serverside.ai in various ways, for example, by providing encoding, storage, or ad-stitching capabilities.

The systems concept also includes configuration settings that let you define any parameters required to connect to and operate each external application.

Each system is uniquely identified by an id (UUID), and the system API routes let you inspect them.

Two systems are installed by default and will be used as examples in Reports: API routes: AMS (Azure Media Services) and SSAI (Serverside.ai).

Reports

Reports belong to a specific system and provide statistical information related to that system. For example, AMS (Azure Media Services) reports include Encoding Jobs and Encoding Minutes, while SSAI (Serverside.ai) reports include Impressions per Ad, Audience Share, and Viewing Time.

Reports are displayed in the front end as preconfigured charts, and the underlying data used to generate these charts can also be downloaded. 

For programmatic access, use the Reports API, which lets you specify parameters such as start and end times, sampling intervals, and other report options. 

To retrieve a report, provide the system ID, report ID, and your Serverside.ai API key.