CDN Data Dictionary

ASN

Autonomous System Number: a unique number identifying a group of IP networks that serves the content to the end-user. Client ASN as determined from a lookup of the client IP.

App Session ID

Datazoom generated UUID for the user's Datazoom session.

Client IP Address

Public IP address of the end user's device

Content Session ID

A unique id for the current video playback session.

User Agent

For web collectors, this is the browser's defined string for user agent. For application collectors, Datazoom composes a psuedo-user agent that contains a number of tokens that refer to aspects of the user device.

Buffer Length (CMCD)

The buffer length associated with the media object being requested.

Buffer Starvation (CMCD)

Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request. If the object type ‘ot’ key is sent along with this key, then the ‘bs’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.

Content ID (CMCD)

A unique string identifying the current content.

Deadline (CMCD)

Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or any other playback problems.

Encoded Bitrate (CMCD)

The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however, it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values, the peak value should be transmitted.

Measured throughput (CMCD)

The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived, SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.

Next Object Request (CMCD)

Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded [5]. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.

Next Range Request (CMCD)

If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is NOT required and specifying multiple ranges is NOT allowed. Valid combinations are: "-" "-" "-"

Object Duration (CMCD)

The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.

Object Type (CMCD)

The media type of the current object being requested: m = text file, such as a manifest or playlist a = audio only v = video only av = muxed audio and video i = init segment c = caption or subtitle tt = ISOBMFF timed text track k = cryptographic key, license or certificate. o = other If the object type being requested is unknown, then this key MUST NOT be used.

Playback Rate (CMCD)

1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.

Request ID (CMCD)

A unique identifier that is established to track an individual media object request made from the client to a CDN.

Requested Maximum Throughput (CMCD)

The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000. Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more. The CDN may not support the rtp feature.

Session ID (CMCD)

A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification [7].

Startup (CMCD)

Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.

Stream Type (CMCD)

Describes if the content being streamed is Live or On Demand.

Streaming Format (CMCD)

The streaming format that defines the current request. d = MPEG DASH h = HTTP Live Streaming (HLS) s = Smooth Streaming o = other If the streaming format being requested is unknown, then this key MUST NOT be used.

Sub-Request ID (CMCD)

A unique identifier that is established to track an internal CDN request where a media object cannot be fulfilled by the initial service receiving the request and gets passed to another node for fulfillment.

Top Bitrate (CMCD)

The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.

Version (CMCD)

The version of the CMCD specification used for interpreting the defined key names and values.

Cache Hit

Boolean value indicating if the response pulled from server's local cache.

Cache Result

Additional information that expands on the cacheHit data point describing the result or actions taken if the cache is unavailable.

CDN

Content Distribution Network name

Content Type

The value of the HTTP Content-Type header of the response.

Host

Host of the client's request.

HTTP Status

HTTP Status Code returned by the server.

City

The city or town where the user is located

Country Code

The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .

Region

The specific administrative division within a country where the event occurred. In the United States, regions correspond to state names ; for example, Washington or New York.

Configuration ID

Datazoom generated identifier for the collector configuration

Event ID

Unique identifier for each event message fired by a Collector or log file received by Datazoom. The string includes an incremental counter at the end to allow for sequencing the events from a user session.

Custom Metadata

Customers can add any user or system data to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.

Referrer

The name of the domain that originated the request.

Timestamp

When the event is received by the Datazoom server in Epoch UTC milliseconds.