In this article, you'll find the instructions for enabling exports directly to your S3 or GCS bucket along with detailed definitions of the current metrics used to detail the Playout Analytics reports. These metrics are displayed within our Playout Hours API endpoint and will allow you to better track and understand the viewership and performance of your playout channels, per region, and destination, among others.
Enabling S3 Exports
To configure an S3 export, follow the instructions below
- Navigate to Settings
- Playout Settings
- Select S3 in the drop-down menu
- Fill out the required fields to connect your S3 bucket
Enabling GCS Exports
To configure a GCS export, follow the instructions below
- Navigate to Settings
- Playout Settings
- Select S3 in the drop-down menu
- Fill out the required fields to connect your GCS account
In this case, the file will be created with the following convention:
export-<analyticsDate>-<uuid>-*.csv.gz
- <analyticsDate> is the ISO representation for the date of execution. E.g.: 2022-03-01 if the date of execution is March 1st, 2022
- <uuid> is a Random, unique identifier. E.g.: 48cea3dd-b0e8-4f8e-b473-9699997ae045
- * is a wildcard required to generate an auto incremental numerical sequence (starting at 0, left-padded to 12 digits) when exported data can be greater than 1 GB. E.g.: 000000000000
Data Definitions:
| site_id | The ID of the customer property in Zype |
| video_id | Video ID of the VOD being streamed in the playout channel |
| video_title | Title of the VOD asset in the Zype CMS |
| session_id | The ID of an ongoing play event, unique to the session of a user |
| channel_id | Playout channel identifier |
| channel_title | Playout channel name |
| playlist_id | The ID of the playlist to which an asset, within that playlist, is being streamed |
| playlist_title | Name of the playlist |
| block_id | The ID of the block to which an asset, contained within that block, is being streamed |
| block_title | Name of the block watched |
| partner_id | Distribution destination identifier (e.g. pluto_tv) |
| country_code | Code of the country were the content is being streamed |
| user_agent | User Agent of the device requesting the content |
| city | City where the request is being made from (if available) |
| state | State where the request is being made from (if available) |
| zip_code | Zip Code where the request is being made from (if available) |
| client_id | Synthetically generated unique device identifier. (unique hashing of IP address & user-agent) |
| play_count | This is identified as a start event from a unique session, per asset |
| duration_watched | Duration of the playback session in seconds |
| duration_watched_hours | Duration of the playback session in hours |
| dma_code | DMA code where the request is being made from (if available) |
| event_dt | Date of the request |
| first_play_start_time | First play event within a unique session (in UTC) |
| last_play_start_time | Last play event within a unique session (in UTC) |
If you have any further questions regarding these metrics, please reach out to support@zype.com
0
0
Was this article helpful?
0 out of 0 found this helpful