Event Bundles¶
Event Bundles are, like Client Reports, a way to get more details from a measurement. However, they are different in the following ways:
- Event bundles only exist for video and web measurements. Each measurement has one (and at most one) event bundle.
- They may not exist forever, so please don't rely on them being available
We provide them so you can dig deeper into the data and analyze it in more detail.
Each event bundle contains:
- metadata (e.g., the type and timestamp) for the bundle
- the actual events, grouped into different categories
Example¶
Here is are two example event bundles, for a web and a video measurement (as identified by the measurement_id):
{
"id": 149,
"type": "VideoEventBundle",
"measurement_id": 1069,
"video_measurement_id": 208, // (1)!
"created_at": "2023-03-08T13:14:59.235Z",
"updated_at": "2023-03-08T13:14:59.425Z",
"state_events": [
{
"type": "loadstart",
"value": 0,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:33.726Z",
"client_time_skewed": "2023-03-08T13:14:33.760Z"
},
{
"type": "play",
"value": 0,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:33.781Z",
"client_time_skewed": "2023-03-08T13:14:33.815Z"
},
{
"type": "waiting",
"value": 0,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:33.781Z",
"client_time_skewed": "2023-03-08T13:14:33.815Z"
},
{
"type": "loadedmetadata",
"value": 0,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:33.816Z",
"client_time_skewed": "2023-03-08T13:14:33.850Z"
},
{
"type": "progress",
"value": 0,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:34.088Z",
"client_time_skewed": "2023-03-08T13:14:34.122Z"
},
// ...
],
"service_specific_state_events": [],
"ad_events": [],
"resolution_events": [
{
"type": "videoDisplaySizeChanged",
"value": [
991,
557
],
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "videoResolutionChanged",
"value": [
480,
270
],
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
// ...
],
"quality_events": [],
"codec_events": [],
"rate_events": [
{
"type": "decodedAudioBytesCountChanged",
"value": 0,
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "decodedVideoBytesCountChanged",
"value": 0,
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "decodedAudioBytesCountChanged",
"value": 7998,
"media_time": 0.892513,
"client_time": "2023-03-08T13:14:36.756Z",
"client_time_skewed": "2023-03-08T13:14:36.790Z"
},
{
"type": "decodedVideoBytesCountChanged",
"value": 44297,
"media_time": 0.892513,
"client_time": "2023-03-08T13:14:36.756Z",
"client_time_skewed": "2023-03-08T13:14:36.790Z"
},
// ...
],
"frame_events": [
{
"type": "decodedFramesCountChanged",
"value": 0,
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "droppedFramesCountChanged",
"value": 0,
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "decodedFramesCountChanged",
"value": 28,
"media_time": 0.892513,
"client_time": "2023-03-08T13:14:36.756Z",
"client_time_skewed": "2023-03-08T13:14:36.790Z"
},
{
"type": "droppedFramesCountChanged",
"value": 1,
"media_time": 0.892513,
"client_time": "2023-03-08T13:14:36.756Z",
"client_time_skewed": "2023-03-08T13:14:36.790Z"
},
// ...
],
"user_events": [],
"raw_events": [],
"debug_events": [],
"buffer_events": [
{
"type": "bufferLengthChanged",
"value": 15.999999,
"source": "html5PlayerApi",
"media_time": 0,
"client_time": "2023-03-08T13:14:35.752Z",
"client_time_skewed": "2023-03-08T13:14:35.786Z"
},
{
"type": "bufferLengthChanged",
"value": 23.999999,
"source": "html5PlayerApi",
"media_time": 0.892513,
"client_time": "2023-03-08T13:14:36.756Z",
"client_time_skewed": "2023-03-08T13:14:36.790Z"
},
// ...
],
"latency_events": [],
"performance_events": []
}
- Please ignore this specific ID for now. It is not used for anything.
This is a bundle for a web measurement.
{
"id": 647,
"type": "WebEventBundle",
"measurement_id": 1077,
"web_measurement_id": 707, // (1)!
"created_at": "2023-03-08T13:27:23.429Z",
"updated_at": "2023-03-08T13:27:23.429Z",
"alert_events": [],
"dom_events": [],
"tab_events": [],
"performance_events": [
{
"type": "onDocumentReady",
"client_time": "2023-03-08T13:27:12.054Z",
"client_time_skewed": "2023-03-08T13:27:12.076Z"
},
{
"type": "onPageLoad",
"client_time": "2023-03-08T13:27:12.406Z",
"client_time_skewed": "2023-03-08T13:27:12.428Z"
}
],
"window_events": [],
"redirect_events": [],
"user_events": [],
"debug_events": [],
"paint_events": [
{
"type": "firstPaint",
"value": 628.8000000715256,
"client_time": "2023-03-08T13:27:12.179Z",
"client_time_skewed": "2023-03-08T13:27:12.201Z"
},
{
"type": "firstContentfulPaint",
"value": 628.8000000715256,
"client_time": "2023-03-08T13:27:12.179Z",
"client_time_skewed": "2023-03-08T13:27:12.201Z"
}
]
}
- Please ignore this specific ID for now. It is not used for anything.
Properties¶
Work in progress
This section is a work in progress. We are working on documenting the properties of the event bundles.