Concept of Tag

Service tagging and filtering

Introduction

Streaming service providers doing white-labeling or B-to-B-to-C (e.g. OVPs, aggregators, resellers, …) typically operate for multiple end customers. Likewise, some Broadcasters and Operators are operating in different markets, globally or regionally. In both scenarios, the need to distinguish consumption for each end customer, market or network becomes important. Service tagging is a key feature to enable consumption filtering by tag. It is essential to manage multiple customer projects (services, consumption), multiple markets or networks on the same broadpeak.io account without having to duplicate Services.

The Service tag feature is available on all broadpeak.io applications (DAI, Virtual Channel, Content Replacement, Adaptive Streaming CDN).

Provisioning

Tags can be added to the service definition through the Webapp or the API during the service creation and update process. The tag syntax is fully user defined and can be chosen to explicitly reflect the different end customer names, markets or network to filter upon.
The following GUI example shows how tags can be defined on a DAI service for instance.


On the API, tags are provisioned as shown below:


Consumption and invoicing

Your broadpeak.io invoice is currently aggregated for all tags.
Nevertheless, through the Webapp or API, you are free to apply tag filtering on the consumption and extract the relevant metrics volume (for example per end customer, market or network).
Once a service is provisioned with tags, consumption can be filtered on any unique tag or combination of tags.



If you prefer to use the API, you simply need to use the tags query parameter in the following end point to specify to GET the relevant metrics.
https://developers.broadpeak.io/reference/consumptionscontroller_gettenantconsumption