General Guidelines

These API endpoints will help you obtain Video and AD data. This data can be further classified into QoE and Qos data.

The required data can be fetched by using the API endpoints along with combinations of metrics and dimensions. This data can further be diced and sliced and featched by using optional query parameters mentioned here.

Request Query Parameters

dimensionstring

An optional query parameter in string format to return the target level for data (eg: microscope)

offset integer

An optional query parameter in integer format to return data with starting index (e.g., 1)

agg string

An optional query parameter in string format to return data by enabling or disabling aggregation (values: 1 or 2)

aggby string

An optional query parameter in string format to return aggregated data with aggregation by (eg.: subscriberid={subscriber-id})

order string

An optional query parameter in string format to return data in order (e.g., DESCOR ASC)

orderbystring

An optional query parameter in string format to return data with order by (eg.: viewercount)

limit string

An optional query parameter in string format to return maximum number of records (e.g., 10)

filter string

An optional query parameter in string format to return data with filter criteria (e.g., subscriberid={subscriber-id})

count integer

An optional query parameter in integer format to return total count of records.

granularity string

An optional query parameter in string format to return granularity of the data (e.g., minute, hour, day).

General Guidelines

To query for totals or averages of metrics over any time range, use the following parameters in the API call:

• dimension=all

• agg=1

To query for totals or averages of metrics over any time range grouped by different values of a dimension, use the following parameters in the API call:

• dimension=all (use dimension = microscope for sessionized data when you are querying for sessionid, subscriberid or ipaddress )

• agg=1

• aggby=<name_of_primary_metric>

To query for total plays per asset, use the following parameters in the API call:

• dimension=all

• count=1

• agg=1

• aggby=assetid

To query for timeline trends, use the following parameters in the API call:

• metrics=timestamp,<all_other_metrics>

• agg=1

• orderby=timestamp

To filter data on a particular dimension, use the following parameters in the API call:

• metrics=<filter_metric_name>

• filter=<filter_metric_name><operator><value>

• agg=1

To filter data of an asset, use the following parameters in the API call (e.g asset name is GameOfThrones) :

• metrics=assetid

• dimension=all

• agg=1

• filter=assetname=GameOfThrones

To query for totals or averages of metrics for a particular dimension value, use :

• dimension=all (use dimension = microscope for sessionized data when you are querying for sessionid, subscriberid or ipaddress )

• agg=1

• filter=<metric name><operator><value>

To query for total play time of an asset, use the following parameters in the API call (e.g asset name is GameOfThrones) :

• metrics=assetid,playdur

• dimension=asset

• count=1

• agg=1

• filter=assetname=GameOfThrones

To sort responses, use:

• orderby=<metric_name>

• order=DESC or order=ASC