SCTE 224 ESNI API

The SCTE 224 ESNI API is accessible through the following base endpoint: https://api.broadpeak.io/v1/esni (see API reference)
The following sections describe the parameters, fields, actions and audiences which are currently supported.

Data model

As a reminder, the following chart illustrates the data model used in ESNI SCTE 224.
It shows the relationships between the main objects normalized and specified in the standard.

954

ESNI SCTE 224 data model

Supported parameters

The following table displays the parameters that are currently supported:

ParameterSupported
MediaYes
MediaPointYes
MatchSignalNo
RemoveNo
ApplyYes
PolicyYes
ViewingPolicyYes
AudienceYes
ResultsNo
AuditNo

Supported fields

The following table displays for each parameter the fields that are currently supported:

FieldMediaMediaPointApplyPolicyViewingPolicyAudience
@idYesYesYesYesYes
@descriptionNoNoNoNoNo
@lastUpdatedNoNoNoNoNo
@xml:baseYesYesYesYesYes
@xlink:hrefYesYesYesYes
@effectiveNoNo
@expiresNoNo
@matchTimeYes
@matchOffsetNo
@sourceYesNo
@expectedDurationYes
@orderNo
@reusableNo
@durationNo
@priorityNo
@matchNo
AltIDNoNoNoNoNo
MetadataNoNoNoNoNo
ExtNoNoNoNoNo
MediaPointYes
RemoveNo
ApplyYes
MatchSignalNo
PolicyYes
ViewingPolicyYes
AudienceYesNo
AnyYesYes

Supported action

The only supported action is action:Content

Supported audiences

The only supported audience element is audience:Zip.
An audience may be empty. In this case the end-user requests must include a "category" query parameter with a value that matches the audience id.