Logo

Data dictionaries

CDN Data Dictionary

Along with any custom event or custom metadata you want to capture, Datazoom CDN Collectors make the following metadata and fluxdata automatically collectable from CDN distribution logs, known as the Datazoom CDN Data Dictionary, to be correlated for analysis alongside data collected from Datazoom Application Collectors configured with a Media Player Extension.

Events

Discrete occurrences driven by user interactions or system actions

Fluxdata

Metrics measuring changing parameters over time

Events

CDN Log

CDN_Log

Supported Collectors 3

Metadata

Network

ASN

asn

Supported Collectors 1
Data type
string
Number Type
Not set

User Details

App Session ID

app_session_id

Supported Collectors 3
Data type
string
Number Type
Not set
Required
true

Client IP Address

client_ip

Supported Collectors 3
Data type
string
Number Type
Not set
Permitted Values
IP address

Content Session ID

content_session_id

Supported Collectors 3
Data type
string
Number Type
Not set
Required
true
Permitted Values
UUID

User Agent

user_agent

Supported Collectors 3
Data type
string
Number Type
Not set

CMCD

Buffer Length (CMCD)

bl

Supported Collectors 3
Data type
number
Number Type
Int
Unit
milliseconds

Buffer Starvation (CMCD)

bs

Supported Collectors 3
Data type
bool
Number Type
Not set
Permitted Values
value list

Content ID (CMCD)

cid

Supported Collectors 3
Data type
string
Number Type
Not set

Deadline (CMCD)

dl

Supported Collectors 3
Data type
number
Number Type
Int
Unit
milliseconds

Encoded Bitrate (CMCD)

br

Supported Collectors 3
Data type
number
Number Type
Int
Unit
kbps

Measured throughput (CMCD)

mtp

Supported Collectors 3
Data type
number
Number Type
Int
Unit
kbps

Next Object Request (CMCD)

nor

Supported Collectors 3
Data type
string
Number Type
Not set

Next Range Request (CMCD)

nrr

Supported Collectors 3
Data type
string
Number Type
Not set

Object Duration (CMCD)

d

Supported Collectors 3
Data type
number
Number Type
Int
Unit
milliseconds

Object Type (CMCD)

ot

Supported Collectors 3
Data type
string
Number Type
Not set
Permitted Values
value list

Playback Rate (CMCD)

pr

Supported Collectors 3
Data type
number
Number Type
Short

Request ID (CMCD)

rid

Supported Collectors 3
Data type
string
Number Type
Not set

Requested Maximum Throughput (CMCD)

rtp

Supported Collectors 3
Data type
number
Number Type
Int
Unit
kbps

Session ID (CMCD)

sid

Supported Collectors 3
Data type
string
Number Type
Not set

Startup (CMCD)

su

Supported Collectors 3
Data type
bool
Number Type
Not set
Permitted Values
value list

Stream Type (CMCD)

st

Supported Collectors 3
Data type
string
Number Type
Not set
Permitted Values
value list

Streaming Format (CMCD)

sf

Supported Collectors 3
Data type
string
Number Type
Not set
Permitted Values
value list

Sub-Request ID (CMCD)

srid

Supported Collectors 3
Data type
string
Number Type
Not set

Top Bitrate (CMCD)

tb

Supported Collectors 3
Data type
number
Number Type
Int
Unit
kbps

Version (CMCD)

v

Supported Collectors 3
Data type
number
Number Type
Short

CDN

Cache Hit

cache_hit

Supported Collectors 3
Data type
bool
Number Type
Not set
Permitted Values
value list

Cache Result

cache_result

Supported Collectors 3
Data type
string
Number Type
Not set

CDN

cdn

Supported Collectors 3
Data type
string
Number Type
Not set

Content Type

content_type

Supported Collectors 3
Data type
string
Number Type
Not set

Host

host

Supported Collectors 3
Data type
string
Number Type
Not set

HTTP Status

http_status

Supported Collectors 3
Data type
string
Number Type
Not set

Location

City

city

Supported Collectors 2
Data type
string
Number Type
Not set
Notes
When aggregated with other player sessions, this can provide a definitive number of viewers within a city. This can be helpful when targeting local advertising.

Country Code

country_code

Supported Collectors 3
Data type
string
Number Type
Not set
Notes
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Permitted Values
2 letter code

Region

region

Supported Collectors 2
Data type
string
Number Type
Not set
Notes
This is the full form of the regionCode (i.e., Florida instead of FL). As a result, this value is often used for display purposes, rather than programmatically. If the fullname of a country region is needed, pulling this field is more efficient than employing memory or CPU to programmatically match the regionCode to a region name.

Message

Configuration ID

configuration_id

Supported Collectors 3
Data type
string
Number Type
Not set
Notes
Allows customers to differentiate data on the Connector from different Collectors (e.g., could be useful for separating test content from production data).
Required
true
Permitted Values
UUID

Event ID

event_id

Supported Collectors 3
Data type
string
Number Type
Not set
Required
true

Custom Data

Custom Metadata

{custom.metadata_name}

Supported Collectors 3
Number Type
Not set

Page

Referrer

referrer

Supported Collectors 2
Data type
string
Number Type
Not set
Permitted Values
URL

Events

Timestamp

timestamp

Supported Collectors 1
Data type
number
Number Type
Not set
Unit
milliseconds
Notes
In cases where two or more events have the same timestamp, please use the event count to determine the sequence in which the events occurred.
Required
true

Fluxdata

Bytes Served

bytes_served

Supported Collectors 3
Device Platforms
Server API

Round Trip Time

round_trip_time_mu

Supported Collectors 1
Device Platforms
Browser,Console,DTV,Mobile,Server API

Time To First Byte

time_to_first_byte_ms

Supported Collectors 3
Device Platforms
Server API

Time To Last Byte

time_to_last_byte_ms

Supported Collectors 3
Device Platforms
Server API