Datapoints¶
Datapoints are an identifier for a series of data values.
This can be compared to a table with data, where each column has a header (which is the data point), and one or more cells containing data.
Data points are grouped by areas and their names are referred to as the area followed by the data point name, separated by a dot. Some examples follow
content.ingested_files # Number of ingested files
playback.contries # Number of countries where users have been recorded to play content
users.active # Number of active users
Variants¶
Where a data point has available variants, they are treated just as another part of the name, separated with a dot.
Some examples follow
subscriptions.created.free # Number of created free subscriptions
playback.sessions.total # The number of playback sessions registered
Types¶
Each data point supports one or more types that dictates how that data point should be aggregated.
Some examples follow
content.transcoding_time_ratio/avg # Number of created free subscriptions
playback.completed/cnt # The number of playback sessions registered
Units¶
For some data points it is possible to specify in what unit they should be returned.
Some examples follow
content.ingested_duration/avg|hours # Number of hours spent on average per ingest
Example¶
In the example below we are displaying data for 2 datapoints: playback.sessions.total/cnt and users.active/cnt.
| playback.sessions.total/cnt | users.active/cnt |
|---|---|
| 52362 | 9760 |
Available data points¶
The available data points can also be found at /v1/dps in the Analytics API.
Content¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| content.ingested_duration | min/max/avg/sum | hours/minutes/seconds/milliseconds h/m/s/ms | Playable duration of ingested content | Reported when the material have successfully finished ingestion | |
| content.ingested_files | cnt | Total number of files ingested | Reported when the material have successfully finished ingestion | ||
| content.ingested_size | min/max/avg/sum | MiB/GiB/PiB/TiB MB/GB/TB/PB | Size of ingested files | ||
| content.ingested_time | min/max/avg/sum | hours/minutes/seconds/milliseconds h/m/s/ms | Time it took to ingest files | ||
| content.origin_storage | min/max/avg | MiB/GiB/PiB/TiB MB/GB/TB/PB | Storage used by content on our origin | ||
| content.transcoding_time | min/max/avg/sum | hours/minutes/seconds/milliseconds h/m/s/ms | Time it took to transcode the file / material | ||
| content.transcoding_time_ratio | min/max/avg | The (percentage) ratio between the time from transcoding start to finish divided by playable duration of file ingested |
Playback¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| playback.ads | started/completed/failed | min/max/avg/sum | The number of ads that have been started/completed/failed for all session during the selected period | ||
| playback.bitrate | min/max/avg | min/max/avg | kbps/Mbps | Bitrate played for user sessions | Reported by the player, and effectively which segments it plays regardless of buffering |
| playback.buffer_ratio | min/max/avg | The (percentage) ratio of time spent buffering divided by the time played or length the session | |||
| playback.completed | cnt | Occurrences where a player passes the end of the content watched | Reported when the player play content past the 95% of the content | ||
| playback.completed_ratio | pct | The (percentage) ratio of completed sessions divided by started sessions, represented by 0.0-1.0 for 0%-100% | |||
| playback.countries | cnt | Number of unique countries where a session startup have been registered | The country is estimated based on the end user IP address as reported by player | ||
| playback.duration | min/max/avg/sum | hours/minutes/seconds/milliseconds h/m/s/ms | Accumulated time played for sessions | Does not include time spent in pause or buffering | |
| playback.sessions | total/unique | cnt | The number of viewing sessions registered for users | Total refers to total number of sessions, while unique refers to the number of users with at least one session | |
| playback.sessions_error | cnt | The number of errors reported, or the number of sessions with errors reported | Total refers to total number of error, while unique refers to the number of sessions with at least one error | ||
| playback.sessions_error_ratio | pct | Unique sessions with reported errors divided by the total number of sessions, represented as a percentage between 0.0-1.0 | |||
| playback.startup | total/unique | cnt | Number of attempts to start playback for sessions | Reported when any activity is reported by the player. Total is the number of sessions - Unique is the number of users that have started a session | |
| playback.startup_failure | total/unique | cnt | Number of failed playback attempts for sessions | Reported when the player receives an error before the playback has started. Total is the number of sessions - Unique is the number of users that have started a session | |
| playback.startup_time | min/max/avg | hours/minutes/seconds/milliseconds h/m/s/ms | The time from when a user presses play in the player to when the first content is displayed | ||
| playback.total_data_usage | sum/avg | MB | Total data usage for each session. This is an EXPERIMENTAL datapoint and should not be taken as a complete truth | Calculated as average bitrate for a session times total viewing duration | |
| playback.total_number_of_dropped_frames | sum/avg | Number of dropped frames for a session |
Metrics¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| metrics.concurrent_streams | min/max/avg | Number of concurrent sessions |
Subscriptions¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| subscriptions.cancellations | cnt | Number of active subscriptions cancelled | Reported on the date when the cancellation is done, not on the last day which the subscription is valid | ||
| subscriptions.cancelled | cnt | Number of previously active subscriptions which are no longer active due to cancellation | Reported on the first date when the subscriptions is no longer valid | ||
| subscriptions.created | all/free/paid | cnt | Number of new subscriptions created | Includes both new and converted subscriptions | |
| subscriptions.renewed | cnt | Number of subscriptions renewed | Reported on the date when the renewal was made, not on the first day of when the renewed subscription would have occurred |
Sale¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| sale.discount | all/manual/voucher | min/max/avg/sum | The discount applied on purchases | ||
| sale.discounted_transactions | all/full | cnt | The number of discounted transactions | Variant all returns all discounted transactions, while variant full returns transactions where the discount is 100% | |
| sale.price | total/subscriptions/rentals/purchases | min/max/avg/sum | Stated price for products bought | Listing price without discounts applied | |
| sale.revenue | total/subscriptions/rentals/purchases | min/max/avg/sum | Total revenue accumulated | ||
| sale.total | all/rentals/purchases/events | cnt | Number of sales made | ||
| sale.vouchers | total/unique | cnt | Redeemed number of promotional codes |
Users¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| users.active | cnt | Number of accounts with activity | Considered active when they have consumed any content | ||
| users.created | cnt | Number of new user accounts created | Includes both new signup and re-creation of removed accounts |
KPI¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| kpi.channel_entitlement_availability | pct | Entitlement availability metric, shows channel entitlement uptime during the period | Reported by continuously probing the channel | ||
| kpi.channel_play_availability | all/dash/hls | pct | Channel availability metric, shows channel uptime during the period | Reported by continuously probing the channel |
Live events¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| live_events.duration | min/max/avg/sum | hours/minutes/seconds/milliseconds h/m/s/ms | Duration of live events |
Clipping service¶
| Name | Variants | Type | Unit | Description | Remarks |
|---|---|---|---|---|---|
| clipping_service.duration | sum | hours/minutes/seconds/milliseconds h/m/s/ms | Total duration of clipping service |