chunkify-analytics-sdk 0.9.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. chunkify_analytics/__init__.py +102 -0
  2. chunkify_analytics/_base_client.py +2153 -0
  3. chunkify_analytics/_client.py +1262 -0
  4. chunkify_analytics/_compat.py +226 -0
  5. chunkify_analytics/_constants.py +14 -0
  6. chunkify_analytics/_exceptions.py +108 -0
  7. chunkify_analytics/_files.py +173 -0
  8. chunkify_analytics/_models.py +964 -0
  9. chunkify_analytics/_qs.py +149 -0
  10. chunkify_analytics/_resource.py +43 -0
  11. chunkify_analytics/_response.py +835 -0
  12. chunkify_analytics/_streaming.py +338 -0
  13. chunkify_analytics/_types.py +274 -0
  14. chunkify_analytics/_utils/__init__.py +64 -0
  15. chunkify_analytics/_utils/_compat.py +45 -0
  16. chunkify_analytics/_utils/_datetime_parse.py +136 -0
  17. chunkify_analytics/_utils/_json.py +35 -0
  18. chunkify_analytics/_utils/_logs.py +25 -0
  19. chunkify_analytics/_utils/_path.py +127 -0
  20. chunkify_analytics/_utils/_proxy.py +65 -0
  21. chunkify_analytics/_utils/_reflection.py +42 -0
  22. chunkify_analytics/_utils/_resources_proxy.py +24 -0
  23. chunkify_analytics/_utils/_streams.py +12 -0
  24. chunkify_analytics/_utils/_sync.py +58 -0
  25. chunkify_analytics/_utils/_transform.py +457 -0
  26. chunkify_analytics/_utils/_typing.py +156 -0
  27. chunkify_analytics/_utils/_utils.py +433 -0
  28. chunkify_analytics/_version.py +4 -0
  29. chunkify_analytics/lib/.keep +4 -0
  30. chunkify_analytics/pagination.py +221 -0
  31. chunkify_analytics/py.typed +0 -0
  32. chunkify_analytics/resources/__init__.py +243 -0
  33. chunkify_analytics/resources/admin/__init__.py +33 -0
  34. chunkify_analytics/resources/admin/admin.py +253 -0
  35. chunkify_analytics/resources/admin/keys.py +283 -0
  36. chunkify_analytics/resources/dimensions.py +436 -0
  37. chunkify_analytics/resources/engagement.py +479 -0
  38. chunkify_analytics/resources/errors.py +400 -0
  39. chunkify_analytics/resources/events.py +562 -0
  40. chunkify_analytics/resources/exports.py +584 -0
  41. chunkify_analytics/resources/health.py +159 -0
  42. chunkify_analytics/resources/playback_rates.py +391 -0
  43. chunkify_analytics/resources/project/__init__.py +33 -0
  44. chunkify_analytics/resources/project/keys.py +379 -0
  45. chunkify_analytics/resources/project/project.py +322 -0
  46. chunkify_analytics/resources/quality.py +471 -0
  47. chunkify_analytics/resources/renditions.py +391 -0
  48. chunkify_analytics/resources/retention.py +377 -0
  49. chunkify_analytics/resources/subtitles.py +389 -0
  50. chunkify_analytics/resources/summary.py +469 -0
  51. chunkify_analytics/resources/timeseries.py +399 -0
  52. chunkify_analytics/resources/videos.py +424 -0
  53. chunkify_analytics/resources/views.py +579 -0
  54. chunkify_analytics/types/__init__.py +145 -0
  55. chunkify_analytics/types/admin/__init__.py +3 -0
  56. chunkify_analytics/types/admin_create_project_params.py +25 -0
  57. chunkify_analytics/types/analytics_event.py +32 -0
  58. chunkify_analytics/types/analytics_event_param.py +30 -0
  59. chunkify_analytics/types/created_project.py +37 -0
  60. chunkify_analytics/types/created_project_key.py +34 -0
  61. chunkify_analytics/types/deleted_project.py +18 -0
  62. chunkify_analytics/types/dimension_list_values_params.py +124 -0
  63. chunkify_analytics/types/dimension_values.py +42 -0
  64. chunkify_analytics/types/engagement.py +60 -0
  65. chunkify_analytics/types/engagement_breakdown_page.py +44 -0
  66. chunkify_analytics/types/engagement_response.py +11 -0
  67. chunkify_analytics/types/engagement_retrieve_params.py +158 -0
  68. chunkify_analytics/types/engagement_timeseries.py +28 -0
  69. chunkify_analytics/types/engagement_timeseries_bucket.py +63 -0
  70. chunkify_analytics/types/error_group.py +17 -0
  71. chunkify_analytics/types/error_list_params.py +124 -0
  72. chunkify_analytics/types/error_page.py +14 -0
  73. chunkify_analytics/types/event_ingest_params.py +19 -0
  74. chunkify_analytics/types/event_ingest_response.py +11 -0
  75. chunkify_analytics/types/event_list_params.py +146 -0
  76. chunkify_analytics/types/event_page.py +18 -0
  77. chunkify_analytics/types/export.py +18 -0
  78. chunkify_analytics/types/export_columns.py +12 -0
  79. chunkify_analytics/types/export_create_params.py +40 -0
  80. chunkify_analytics/types/export_download_response.py +7 -0
  81. chunkify_analytics/types/export_list_columns_params.py +69 -0
  82. chunkify_analytics/types/export_query_param.py +141 -0
  83. chunkify_analytics/types/health.py +11 -0
  84. chunkify_analytics/types/metrics.py +13 -0
  85. chunkify_analytics/types/metrics_breakdown_page.py +40 -0
  86. chunkify_analytics/types/metrics_response.py +11 -0
  87. chunkify_analytics/types/native_created.py +13 -0
  88. chunkify_analytics/types/native_duplicate.py +13 -0
  89. chunkify_analytics/types/playback_error.py +180 -0
  90. chunkify_analytics/types/playback_error_param.py +182 -0
  91. chunkify_analytics/types/playback_rate_changed.py +150 -0
  92. chunkify_analytics/types/playback_rate_changed_param.py +152 -0
  93. chunkify_analytics/types/playback_rate_metric.py +21 -0
  94. chunkify_analytics/types/playback_rate_report.py +31 -0
  95. chunkify_analytics/types/playback_rate_retrieve_params.py +117 -0
  96. chunkify_analytics/types/playback_state_changed.py +150 -0
  97. chunkify_analytics/types/playback_state_changed_param.py +156 -0
  98. chunkify_analytics/types/project/__init__.py +6 -0
  99. chunkify_analytics/types/project/key_create_params.py +21 -0
  100. chunkify_analytics/types/project/project.py +35 -0
  101. chunkify_analytics/types/project_key.py +21 -0
  102. chunkify_analytics/types/project_keys.py +14 -0
  103. chunkify_analytics/types/project_update_params.py +25 -0
  104. chunkify_analytics/types/quality.py +117 -0
  105. chunkify_analytics/types/quality_breakdown_page.py +44 -0
  106. chunkify_analytics/types/quality_response.py +11 -0
  107. chunkify_analytics/types/quality_retrieve_params.py +158 -0
  108. chunkify_analytics/types/quality_timeseries.py +28 -0
  109. chunkify_analytics/types/quality_timeseries_bucket.py +120 -0
  110. chunkify_analytics/types/rendition_changed.py +156 -0
  111. chunkify_analytics/types/rendition_changed_param.py +158 -0
  112. chunkify_analytics/types/rendition_metric.py +40 -0
  113. chunkify_analytics/types/rendition_report.py +43 -0
  114. chunkify_analytics/types/rendition_retrieve_params.py +117 -0
  115. chunkify_analytics/types/retention_bucket.py +22 -0
  116. chunkify_analytics/types/retention_report.py +33 -0
  117. chunkify_analytics/types/retention_retrieve_params.py +110 -0
  118. chunkify_analytics/types/rotated_project_key.py +29 -0
  119. chunkify_analytics/types/seek_completed.py +166 -0
  120. chunkify_analytics/types/seek_completed_param.py +168 -0
  121. chunkify_analytics/types/shared/__init__.py +24 -0
  122. chunkify_analytics/types/shared/browser_context.py +62 -0
  123. chunkify_analytics/types/shared/custom_dimensions.py +8 -0
  124. chunkify_analytics/types/shared/event_context.py +161 -0
  125. chunkify_analytics/types/shared/event_envelope.py +152 -0
  126. chunkify_analytics/types/shared/metric_count_ratio.py +18 -0
  127. chunkify_analytics/types/shared/otlp_any_value.py +56 -0
  128. chunkify_analytics/types/shared/otlp_attribute.py +24 -0
  129. chunkify_analytics/types/shared/otlp_attribute_value.py +136 -0
  130. chunkify_analytics/types/shared/otlp_context_attribute.py +22 -0
  131. chunkify_analytics/types/shared/otlp_log_record.py +48 -0
  132. chunkify_analytics/types/shared/otlp_resource.py +20 -0
  133. chunkify_analytics/types/shared/otlp_scope.py +24 -0
  134. chunkify_analytics/types/shared/playback_rate_playing_time.py +12 -0
  135. chunkify_analytics/types/shared/playback_score.py +28 -0
  136. chunkify_analytics/types/shared/played_range.py +13 -0
  137. chunkify_analytics/types/shared/progress_reached.py +39 -0
  138. chunkify_analytics/types/shared/rendition_playing_time.py +21 -0
  139. chunkify_analytics/types/shared/startup_outcomes.py +39 -0
  140. chunkify_analytics/types/shared/stored_otlp_context.py +50 -0
  141. chunkify_analytics/types/shared/subtitle_playing_time.py +14 -0
  142. chunkify_analytics/types/shared/view_metrics.py +100 -0
  143. chunkify_analytics/types/shared/watch_time_distribution.py +41 -0
  144. chunkify_analytics/types/shared_params/__init__.py +8 -0
  145. chunkify_analytics/types/shared_params/browser_context.py +62 -0
  146. chunkify_analytics/types/shared_params/custom_dimensions.py +10 -0
  147. chunkify_analytics/types/shared_params/playback_rate_playing_time.py +14 -0
  148. chunkify_analytics/types/shared_params/played_range.py +15 -0
  149. chunkify_analytics/types/shared_params/rendition_playing_time.py +22 -0
  150. chunkify_analytics/types/shared_params/subtitle_playing_time.py +15 -0
  151. chunkify_analytics/types/stored_event.py +44 -0
  152. chunkify_analytics/types/subtitle_changed.py +150 -0
  153. chunkify_analytics/types/subtitle_changed_param.py +152 -0
  154. chunkify_analytics/types/subtitle_metric.py +26 -0
  155. chunkify_analytics/types/subtitle_report.py +31 -0
  156. chunkify_analytics/types/subtitle_retrieve_params.py +117 -0
  157. chunkify_analytics/types/summary_retrieve_params.py +158 -0
  158. chunkify_analytics/types/time_bucket.py +22 -0
  159. chunkify_analytics/types/timeseries.py +28 -0
  160. chunkify_analytics/types/timeseries_response.py +12 -0
  161. chunkify_analytics/types/timesery_retrieve_params.py +115 -0
  162. chunkify_analytics/types/video_list_params.py +140 -0
  163. chunkify_analytics/types/video_metrics.py +23 -0
  164. chunkify_analytics/types/video_page.py +14 -0
  165. chunkify_analytics/types/view.py +43 -0
  166. chunkify_analytics/types/view_detail.py +21 -0
  167. chunkify_analytics/types/view_ended.py +180 -0
  168. chunkify_analytics/types/view_ended_param.py +182 -0
  169. chunkify_analytics/types/view_list_params.py +152 -0
  170. chunkify_analytics/types/view_page.py +14 -0
  171. chunkify_analytics/types/view_retrieve_params.py +23 -0
  172. chunkify_analytics/types/view_snapshot.py +180 -0
  173. chunkify_analytics/types/view_snapshot_param.py +182 -0
  174. chunkify_analytics/types/view_started.py +192 -0
  175. chunkify_analytics/types/view_started_param.py +194 -0
  176. chunkify_analytics_sdk-0.9.0.dist-info/METADATA +487 -0
  177. chunkify_analytics_sdk-0.9.0.dist-info/RECORD +179 -0
  178. chunkify_analytics_sdk-0.9.0.dist-info/WHEEL +4 -0
  179. chunkify_analytics_sdk-0.9.0.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,110 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Union
6
+ from datetime import datetime
7
+ from typing_extensions import Literal, Required, Annotated, TypedDict
8
+
9
+ from .._utils import PropertyInfo
10
+
11
+ __all__ = ["RetentionRetrieveParams"]
12
+
13
+
14
+ class RetentionRetrieveParams(TypedDict, total=False):
15
+ video_id: Required[str]
16
+ """Video to report. Retention measures one video at a time."""
17
+
18
+ browser_name: str
19
+ """Exact browser name, such as Chrome. Missing values do not match."""
20
+
21
+ city: str
22
+ """
23
+ Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
24
+ characters. Use country alongside city to distinguish places with the same name.
25
+ Missing locations do not match.
26
+ """
27
+
28
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"]
29
+ """Exact continent code from the local lookup. Missing locations do not match."""
30
+
31
+ country: str
32
+ """Exact uppercase ISO 3166-1 alpha-2 country code, such as GB.
33
+
34
+ Missing locations do not match.
35
+ """
36
+
37
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"]
38
+ """Exact device class. unknown matches an explicit unknown value."""
39
+
40
+ from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
41
+ """Inclusive RFC3339 occurrence-time lower bound, with timezone.
42
+
43
+ Summary/video queries apply it to the selected view_started event. Must be
44
+ before to.
45
+ """
46
+
47
+ os_name: str
48
+ """Exact operating-system name, such as macOS. Missing values do not match."""
49
+
50
+ page_origin: str
51
+ """
52
+ Exact, case-sensitive page origin captured by the player, such as
53
+ https://example.com. Metrics use the first retained view start; raw events use
54
+ each event context. Missing values do not match.
55
+ """
56
+
57
+ page_path: str
58
+ """Exact, case-sensitive page path captured by the player, such as /watch/video.
59
+
60
+ Filter by page_origin as well to distinguish identical paths on different sites.
61
+ Metrics use the first retained view start; raw events use each event context.
62
+ Missing values do not match.
63
+ """
64
+
65
+ playback_rate: str
66
+ """
67
+ Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
68
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
69
+ start; raw events use each event's value.
70
+ """
71
+
72
+ subtitle_language: str
73
+ """
74
+ Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
75
+ for a subtitles track without a language. Metrics use the language showing on
76
+ the first retained view start; raw events use each event's value. Views without
77
+ subtitles at start do not match.
78
+ """
79
+
80
+ to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
81
+ """Exclusive RFC3339 occurrence-time upper bound, with timezone.
82
+
83
+ Summary/video queries apply it to the selected view_started event.
84
+ """
85
+
86
+ user_id: str
87
+ """Exact integrator-supplied user ID.
88
+
89
+ Selects views by their start event; event lists match each event's own value.
90
+ Missing/null user IDs do not match. Reports with this filter read one stored row
91
+ per view.
92
+ """
93
+
94
+ video_title: str
95
+ """Exact, case-sensitive video title.
96
+
97
+ Selects views by the title on their first retained start; event lists match each
98
+ event's own value. Views without a title do not match. Reports with this filter
99
+ read one stored row per view.
100
+ """
101
+
102
+ view_id: str
103
+ """Filter one playback attempt by view ID. Metrics use its first retained start."""
104
+
105
+ viewer_id: str
106
+ """Exact viewer ID.
107
+
108
+ The Chunkify player SDK generates one per browser; missing/null viewer IDs do
109
+ not match.
110
+ """
@@ -0,0 +1,29 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+ from typing_extensions import Literal
5
+
6
+ from .._models import BaseModel
7
+
8
+ __all__ = ["RotatedProjectKey"]
9
+
10
+
11
+ class RotatedProjectKey(BaseModel):
12
+ key: str
13
+ """New key value. Save it now; it is returned once."""
14
+
15
+ key_id: str
16
+
17
+ permission: Literal["public", "secret"]
18
+
19
+ project_id: str
20
+
21
+ read_only: bool
22
+ """True for a private key limited to analytics reads through HTTP and MCP.
23
+
24
+ Public keys always report false. Rotation preserves this setting.
25
+ """
26
+
27
+ restart_required: Literal[False]
28
+
29
+ warning: Optional[str] = None
@@ -0,0 +1,166 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Union, Optional
4
+ from datetime import datetime
5
+ from typing_extensions import Literal
6
+
7
+ from .._models import BaseModel
8
+ from .shared.browser_context import BrowserContext
9
+ from .shared.rendition_playing_time import RenditionPlayingTime
10
+
11
+ __all__ = ["SeekCompleted"]
12
+
13
+
14
+ class SeekCompleted(BaseModel):
15
+ connector_name: str
16
+
17
+ connector_version: Optional[str] = None
18
+
19
+ delivery_hostname: Optional[str] = None
20
+
21
+ environment: Optional[str] = None
22
+
23
+ error_category: Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]] = None
24
+
25
+ error_code: Union[str, float, None] = None
26
+
27
+ error_fatal: Optional[bool] = None
28
+
29
+ error_playhead_seconds: Optional[float] = None
30
+
31
+ event_id: str
32
+
33
+ event_name: Literal["chunkify.video.seek_completed"]
34
+
35
+ from_playhead_seconds: Optional[float] = None
36
+
37
+ last_seeked_at: Optional[datetime] = None
38
+
39
+ occurred_at: datetime
40
+
41
+ playback_resumed_at: Optional[datetime] = None
42
+
43
+ player_name: Optional[str] = None
44
+
45
+ player_version: Optional[str] = None
46
+
47
+ reason: Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]] = None
48
+
49
+ schema_version: Literal[1]
50
+
51
+ sdk_name: str
52
+ """Name of the SDK or integration that produced the event.
53
+
54
+ Informational metadata, preserved as received. Must contain at least one
55
+ non-whitespace character.
56
+ """
57
+
58
+ sdk_version: str
59
+
60
+ seek_interaction_duration_ms: float
61
+
62
+ seek_outcome: Literal["resumed", "paused", "interrupted"]
63
+
64
+ seek_resume_wait_ms: Optional[float] = None
65
+
66
+ seek_started_at: datetime
67
+
68
+ sequence: int
69
+
70
+ startup_outcome: Optional[Literal["started", "failed_before_start", "ended_before_start"]] = None
71
+
72
+ state_after_seek: Literal[
73
+ "startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"
74
+ ]
75
+
76
+ state_before_seek: Literal[
77
+ "startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"
78
+ ]
79
+
80
+ to_playhead_seconds: Optional[float] = None
81
+
82
+ video_id: str
83
+
84
+ view_id: str
85
+
86
+ viewer_id: Optional[str] = None
87
+ """
88
+ Anonymous browser identifier generated by the Chunkify player SDK and stored in
89
+ the page's localStorage.
90
+ """
91
+
92
+ browser_context: Optional[BrowserContext] = None
93
+ """Browser and device information.
94
+
95
+ The Chunkify player sends every field, with null for unavailable measurements.
96
+ Other integrations may omit any field except schema_version. Extra properties
97
+ are preserved.
98
+ """
99
+
100
+ delivery_request_count: Optional[float] = None
101
+
102
+ delivery_throughput_bps: Optional[float] = None
103
+
104
+ delivery_transferred_bytes: Optional[float] = None
105
+
106
+ dropped_video_frames: Optional[float] = None
107
+
108
+ first_video_frame_time_ms: Optional[float] = None
109
+
110
+ furthest_progress_ratio: Optional[float] = None
111
+
112
+ maximum_playhead_seconds: Optional[float] = None
113
+
114
+ media_duration_seconds: Optional[float] = None
115
+
116
+ media_height_px: Optional[float] = None
117
+
118
+ media_width_px: Optional[float] = None
119
+
120
+ player_height_px: Optional[float] = None
121
+
122
+ player_width_px: Optional[float] = None
123
+
124
+ playing_time_ms: Optional[float] = None
125
+
126
+ rebuffer_count: Optional[float] = None
127
+
128
+ rebuffer_duration_ms: Optional[float] = None
129
+
130
+ rebuffer_ratio: Optional[float] = None
131
+
132
+ rendition_playing_time: Optional[List[RenditionPlayingTime]] = None
133
+
134
+ rendition_switch_count: Optional[float] = None
135
+
136
+ seek_count: Optional[float] = None
137
+
138
+ seek_duration_ms: Optional[float] = None
139
+
140
+ selected_rendition_bitrate_bps: Optional[float] = None
141
+
142
+ selected_rendition_codec: Optional[str] = None
143
+
144
+ selected_rendition_height: Optional[float] = None
145
+
146
+ selected_rendition_width: Optional[float] = None
147
+
148
+ startup_time_ms: Optional[float] = None
149
+
150
+ total_video_frames: Optional[float] = None
151
+
152
+ user_id: Optional[str] = None
153
+ """
154
+ Optional integrator-supplied user ID, used to link views to the integrator's own
155
+ users.
156
+ """
157
+
158
+ video_title: Optional[str] = None
159
+ """Optional human-readable video title for reports."""
160
+
161
+ visibility_state: Optional[Literal["visible", "hidden"]] = None
162
+ """Tab visibility when the event was recorded.
163
+
164
+ Hidden does not imply paused playback or identify the cause of a pause. Missing
165
+ on older events; null when unavailable.
166
+ """
@@ -0,0 +1,168 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Union, Iterable, Optional
6
+ from datetime import datetime
7
+ from typing_extensions import Literal, Required, Annotated, TypedDict
8
+
9
+ from .._utils import PropertyInfo
10
+ from .shared_params.browser_context import BrowserContext
11
+ from .shared_params.rendition_playing_time import RenditionPlayingTime
12
+
13
+ __all__ = ["SeekCompletedParam"]
14
+
15
+
16
+ class SeekCompletedParam(TypedDict, total=False):
17
+ connector_name: Required[str]
18
+
19
+ connector_version: Required[Optional[str]]
20
+
21
+ delivery_hostname: Required[Optional[str]]
22
+
23
+ environment: Required[Optional[str]]
24
+
25
+ error_category: Required[Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]]]
26
+
27
+ error_code: Required[Union[str, float, None]]
28
+
29
+ error_fatal: Required[Optional[bool]]
30
+
31
+ error_playhead_seconds: Required[Optional[float]]
32
+
33
+ event_id: Required[str]
34
+
35
+ event_name: Required[Literal["chunkify.video.seek_completed"]]
36
+
37
+ from_playhead_seconds: Required[Optional[float]]
38
+
39
+ last_seeked_at: Required[Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]]
40
+
41
+ occurred_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
42
+
43
+ playback_resumed_at: Required[Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]]
44
+
45
+ player_name: Required[Optional[str]]
46
+
47
+ player_version: Required[Optional[str]]
48
+
49
+ reason: Required[Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]]]
50
+
51
+ schema_version: Required[Literal[1]]
52
+
53
+ sdk_name: Required[str]
54
+ """Name of the SDK or integration that produced the event.
55
+
56
+ Informational metadata, preserved as received. Must contain at least one
57
+ non-whitespace character.
58
+ """
59
+
60
+ sdk_version: Required[str]
61
+
62
+ seek_interaction_duration_ms: Required[float]
63
+
64
+ seek_outcome: Required[Literal["resumed", "paused", "interrupted"]]
65
+
66
+ seek_resume_wait_ms: Required[Optional[float]]
67
+
68
+ seek_started_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
69
+
70
+ sequence: Required[int]
71
+
72
+ startup_outcome: Required[Optional[Literal["started", "failed_before_start", "ended_before_start"]]]
73
+
74
+ state_after_seek: Required[
75
+ Literal["startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"]
76
+ ]
77
+
78
+ state_before_seek: Required[
79
+ Literal["startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"]
80
+ ]
81
+
82
+ to_playhead_seconds: Required[Optional[float]]
83
+
84
+ video_id: Required[str]
85
+
86
+ view_id: Required[str]
87
+
88
+ viewer_id: Required[Optional[str]]
89
+ """
90
+ Anonymous browser identifier generated by the Chunkify player SDK and stored in
91
+ the page's localStorage.
92
+ """
93
+
94
+ browser_context: Optional[BrowserContext]
95
+ """Browser and device information.
96
+
97
+ The Chunkify player sends every field, with null for unavailable measurements.
98
+ Other integrations may omit any field except schema_version. Extra properties
99
+ are preserved.
100
+ """
101
+
102
+ delivery_request_count: Optional[float]
103
+
104
+ delivery_throughput_bps: Optional[float]
105
+
106
+ delivery_transferred_bytes: Optional[float]
107
+
108
+ dropped_video_frames: Optional[float]
109
+
110
+ first_video_frame_time_ms: Optional[float]
111
+
112
+ furthest_progress_ratio: Optional[float]
113
+
114
+ maximum_playhead_seconds: float
115
+
116
+ media_duration_seconds: Optional[float]
117
+
118
+ media_height_px: Optional[float]
119
+
120
+ media_width_px: Optional[float]
121
+
122
+ player_height_px: Optional[float]
123
+
124
+ player_width_px: Optional[float]
125
+
126
+ playing_time_ms: float
127
+
128
+ rebuffer_count: float
129
+
130
+ rebuffer_duration_ms: float
131
+
132
+ rebuffer_ratio: Optional[float]
133
+
134
+ rendition_playing_time: Optional[Iterable[RenditionPlayingTime]]
135
+
136
+ rendition_switch_count: Optional[float]
137
+
138
+ seek_count: float
139
+
140
+ seek_duration_ms: float
141
+
142
+ selected_rendition_bitrate_bps: Optional[float]
143
+
144
+ selected_rendition_codec: Optional[str]
145
+
146
+ selected_rendition_height: Optional[float]
147
+
148
+ selected_rendition_width: Optional[float]
149
+
150
+ startup_time_ms: Optional[float]
151
+
152
+ total_video_frames: Optional[float]
153
+
154
+ user_id: Optional[str]
155
+ """
156
+ Optional integrator-supplied user ID, used to link views to the integrator's own
157
+ users.
158
+ """
159
+
160
+ video_title: Optional[str]
161
+ """Optional human-readable video title for reports."""
162
+
163
+ visibility_state: Optional[Literal["visible", "hidden"]]
164
+ """Tab visibility when the event was recorded.
165
+
166
+ Hidden does not imply paused playback or identify the cause of a pause. Missing
167
+ on older events; null when unavailable.
168
+ """
@@ -0,0 +1,24 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from .otlp_scope import OtlpScope as OtlpScope
4
+ from .played_range import PlayedRange as PlayedRange
5
+ from .view_metrics import ViewMetrics as ViewMetrics
6
+ from .event_context import EventContext as EventContext
7
+ from .otlp_resource import OtlpResource as OtlpResource
8
+ from .event_envelope import EventEnvelope as EventEnvelope
9
+ from .otlp_any_value import OtlpAnyValue as OtlpAnyValue
10
+ from .otlp_attribute import OtlpAttribute as OtlpAttribute
11
+ from .playback_score import PlaybackScore as PlaybackScore
12
+ from .browser_context import BrowserContext as BrowserContext
13
+ from .otlp_log_record import OtlpLogRecord as OtlpLogRecord
14
+ from .progress_reached import ProgressReached as ProgressReached
15
+ from .startup_outcomes import StartupOutcomes as StartupOutcomes
16
+ from .custom_dimensions import CustomDimensions as CustomDimensions
17
+ from .metric_count_ratio import MetricCountRatio as MetricCountRatio
18
+ from .stored_otlp_context import StoredOtlpContext as StoredOtlpContext
19
+ from .otlp_attribute_value import OtlpAttributeValue as OtlpAttributeValue
20
+ from .subtitle_playing_time import SubtitlePlayingTime as SubtitlePlayingTime
21
+ from .otlp_context_attribute import OtlpContextAttribute as OtlpContextAttribute
22
+ from .rendition_playing_time import RenditionPlayingTime as RenditionPlayingTime
23
+ from .watch_time_distribution import WatchTimeDistribution as WatchTimeDistribution
24
+ from .playback_rate_playing_time import PlaybackRatePlayingTime as PlaybackRatePlayingTime
@@ -0,0 +1,62 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+ from typing_extensions import Literal
5
+
6
+ from ..._models import BaseModel
7
+
8
+ __all__ = ["BrowserContext"]
9
+
10
+
11
+ class BrowserContext(BaseModel):
12
+ """Browser and device information.
13
+
14
+ The Chunkify player sends every field, with null for unavailable measurements. Other integrations may omit any field except schema_version. Extra properties are preserved.
15
+ """
16
+
17
+ schema_version: Literal[1]
18
+
19
+ browser_name: Optional[str] = None
20
+
21
+ browser_version: Optional[str] = None
22
+
23
+ device_family: Optional[str] = None
24
+
25
+ device_type: Optional[Literal["desktop", "mobile", "tablet", "unknown"]] = None
26
+
27
+ language: Optional[str] = None
28
+
29
+ language_prefix: Optional[str] = None
30
+
31
+ os_name: Optional[str] = None
32
+
33
+ os_version: Optional[str] = None
34
+
35
+ page_origin: Optional[str] = None
36
+ """Current document HTTP(S) origin, without credentials.
37
+
38
+ Null when unavailable or longer than 2048 characters.
39
+ """
40
+
41
+ page_path: Optional[str] = None
42
+ """Current document pathname, without query parameters or fragment.
43
+
44
+ Null when unavailable or longer than 2048 characters. Paths may contain
45
+ application-defined identifiers.
46
+ """
47
+
48
+ pixel_ratio: Optional[float] = None
49
+
50
+ screen_height_px: Optional[int] = None
51
+
52
+ screen_width_px: Optional[int] = None
53
+
54
+ timezone: Optional[str] = None
55
+
56
+ timezone_offset_minutes: Optional[int] = None
57
+
58
+ user_agent: Optional[str] = None
59
+
60
+ viewport_height_px: Optional[int] = None
61
+
62
+ viewport_width_px: Optional[int] = None
@@ -0,0 +1,8 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Dict, Union
4
+ from typing_extensions import TypeAlias
5
+
6
+ __all__ = ["CustomDimensions"]
7
+
8
+ CustomDimensions: TypeAlias = Dict[str, Union[str, float, bool]]