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,424 @@
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
8
+
9
+ import httpx
10
+
11
+ from ..types import video_list_params
12
+ from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
13
+ from .._utils import maybe_transform
14
+ from .._compat import cached_property
15
+ from .._resource import SyncAPIResource, AsyncAPIResource
16
+ from .._response import (
17
+ to_raw_response_wrapper,
18
+ to_streamed_response_wrapper,
19
+ async_to_raw_response_wrapper,
20
+ async_to_streamed_response_wrapper,
21
+ )
22
+ from ..pagination import SyncVideosPage, AsyncVideosPage
23
+ from .._base_client import AsyncPaginator, make_request_options
24
+ from ..types.video_metrics import VideoMetrics
25
+
26
+ __all__ = ["VideosResource", "AsyncVideosResource"]
27
+
28
+
29
+ class VideosResource(SyncAPIResource):
30
+ """Private retained-event and view-cohort queries."""
31
+
32
+ @cached_property
33
+ def with_raw_response(self) -> VideosResourceWithRawResponse:
34
+ """
35
+ This property can be used as a prefix for any HTTP method call to return
36
+ the raw response object instead of the parsed content.
37
+
38
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
39
+ """
40
+ return VideosResourceWithRawResponse(self)
41
+
42
+ @cached_property
43
+ def with_streaming_response(self) -> VideosResourceWithStreamingResponse:
44
+ """
45
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
46
+
47
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
48
+ """
49
+ return VideosResourceWithStreamingResponse(self)
50
+
51
+ def list(
52
+ self,
53
+ *,
54
+ browser_name: str | Omit = omit,
55
+ city: str | Omit = omit,
56
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
57
+ country: str | Omit = omit,
58
+ cursor: str | Omit = omit,
59
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
60
+ from_: Union[str, datetime] | Omit = omit,
61
+ limit: int | Omit = omit,
62
+ order: Literal["asc", "desc"] | Omit = omit,
63
+ os_name: str | Omit = omit,
64
+ page_origin: str | Omit = omit,
65
+ page_path: str | Omit = omit,
66
+ playback_rate: str | Omit = omit,
67
+ sort_by: Literal["video_id", "views", "unique_viewers", "total_playing_time_ms", "playback_score"]
68
+ | Omit = omit,
69
+ subtitle_language: str | Omit = omit,
70
+ to: Union[str, datetime] | Omit = omit,
71
+ user_id: str | Omit = omit,
72
+ video_id: str | Omit = omit,
73
+ video_title: str | Omit = omit,
74
+ view_id: str | Omit = omit,
75
+ viewer_id: str | Omit = omit,
76
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
77
+ # The extra values given here take precedence over values defined on the client or passed to this method.
78
+ extra_headers: Headers | None = None,
79
+ extra_query: Query | None = None,
80
+ extra_body: Body | None = None,
81
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
82
+ ) -> SyncVideosPage[VideoMetrics]:
83
+ """List per-video totals.
84
+
85
+ Sort the entire filtered cohort by video_id, views,
86
+ unique_viewers, total_playing_time_ms or playback_score before pagination.
87
+ Defaults to video_id ascending. Missing scores come last; metric ties use
88
+ video_id ascending in both directions. Unique viewer counts cannot be added
89
+ across videos. Keep sort_by, order and filters unchanged with a cursor.
90
+
91
+ Args:
92
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
93
+
94
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
95
+ characters. Use country alongside city to distinguish places with the same name.
96
+ Missing locations do not match.
97
+
98
+ continent: Exact continent code from the local lookup. Missing locations do not match.
99
+
100
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
101
+ do not match.
102
+
103
+ cursor: Use next_cursor from the previous page. Keep the same filters, sort_by and
104
+ order. Video cursors from earlier versions are invalid; start a new pagination
105
+ sequence after upgrading.
106
+
107
+ device_type: Exact device class. unknown matches an explicit unknown value.
108
+
109
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
110
+ queries apply it to the selected view_started event. Must be before to.
111
+
112
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
113
+ quality and engagement support it only with group_by.
114
+
115
+ order: Sort direction. Events and videos default to asc; views default to desc. Events
116
+ sort by ingestion sequence. Videos and views sort by sort_by with missing values
117
+ last. View ties use view_id in the requested direction; video metric ties use
118
+ video_id ascending.
119
+
120
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
121
+
122
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
123
+ https://example.com. Metrics use the first retained view start; raw events use
124
+ each event context. Missing values do not match.
125
+
126
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
127
+ Filter by page_origin as well to distinguish identical paths on different sites.
128
+ Metrics use the first retained view start; raw events use each event context.
129
+ Missing values do not match.
130
+
131
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
132
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
133
+ start; raw events use each event's value.
134
+
135
+ sort_by: Rank all matching videos before pagination. Missing scores come last in both
136
+ directions. Metric ties use video_id ascending. Keep sort_by, order and filters
137
+ unchanged with a cursor.
138
+
139
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
140
+ for a subtitles track without a language. Metrics use the language showing on
141
+ the first retained view start; raw events use each event's value. Views without
142
+ subtitles at start do not match.
143
+
144
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
145
+ queries apply it to the selected view_started event.
146
+
147
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
148
+ lists match each event's own value. Missing/null user IDs do not match. Reports
149
+ with this filter read one stored row per view.
150
+
151
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
152
+
153
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
154
+ retained start; event lists match each event's own value. Views without a title
155
+ do not match. Reports with this filter read one stored row per view.
156
+
157
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
158
+
159
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
160
+ viewer IDs do not match.
161
+
162
+ extra_headers: Send extra headers
163
+
164
+ extra_query: Add additional query parameters to the request
165
+
166
+ extra_body: Add additional JSON properties to the request
167
+
168
+ timeout: Override the client-level default timeout for this request, in seconds
169
+ """
170
+ return self._get_api_list(
171
+ "/v1/videos",
172
+ page=SyncVideosPage[VideoMetrics],
173
+ options=make_request_options(
174
+ extra_headers=extra_headers,
175
+ extra_query=extra_query,
176
+ extra_body=extra_body,
177
+ timeout=timeout,
178
+ query=maybe_transform(
179
+ {
180
+ "browser_name": browser_name,
181
+ "city": city,
182
+ "continent": continent,
183
+ "country": country,
184
+ "cursor": cursor,
185
+ "device_type": device_type,
186
+ "from_": from_,
187
+ "limit": limit,
188
+ "order": order,
189
+ "os_name": os_name,
190
+ "page_origin": page_origin,
191
+ "page_path": page_path,
192
+ "playback_rate": playback_rate,
193
+ "sort_by": sort_by,
194
+ "subtitle_language": subtitle_language,
195
+ "to": to,
196
+ "user_id": user_id,
197
+ "video_id": video_id,
198
+ "video_title": video_title,
199
+ "view_id": view_id,
200
+ "viewer_id": viewer_id,
201
+ },
202
+ video_list_params.VideoListParams,
203
+ ),
204
+ security={"secret_key": True},
205
+ ),
206
+ model=VideoMetrics,
207
+ )
208
+
209
+
210
+ class AsyncVideosResource(AsyncAPIResource):
211
+ """Private retained-event and view-cohort queries."""
212
+
213
+ @cached_property
214
+ def with_raw_response(self) -> AsyncVideosResourceWithRawResponse:
215
+ """
216
+ This property can be used as a prefix for any HTTP method call to return
217
+ the raw response object instead of the parsed content.
218
+
219
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
220
+ """
221
+ return AsyncVideosResourceWithRawResponse(self)
222
+
223
+ @cached_property
224
+ def with_streaming_response(self) -> AsyncVideosResourceWithStreamingResponse:
225
+ """
226
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
227
+
228
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
229
+ """
230
+ return AsyncVideosResourceWithStreamingResponse(self)
231
+
232
+ def list(
233
+ self,
234
+ *,
235
+ browser_name: str | Omit = omit,
236
+ city: str | Omit = omit,
237
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
238
+ country: str | Omit = omit,
239
+ cursor: str | Omit = omit,
240
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
241
+ from_: Union[str, datetime] | Omit = omit,
242
+ limit: int | Omit = omit,
243
+ order: Literal["asc", "desc"] | Omit = omit,
244
+ os_name: str | Omit = omit,
245
+ page_origin: str | Omit = omit,
246
+ page_path: str | Omit = omit,
247
+ playback_rate: str | Omit = omit,
248
+ sort_by: Literal["video_id", "views", "unique_viewers", "total_playing_time_ms", "playback_score"]
249
+ | Omit = omit,
250
+ subtitle_language: str | Omit = omit,
251
+ to: Union[str, datetime] | Omit = omit,
252
+ user_id: str | Omit = omit,
253
+ video_id: str | Omit = omit,
254
+ video_title: str | Omit = omit,
255
+ view_id: str | Omit = omit,
256
+ viewer_id: str | Omit = omit,
257
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
258
+ # The extra values given here take precedence over values defined on the client or passed to this method.
259
+ extra_headers: Headers | None = None,
260
+ extra_query: Query | None = None,
261
+ extra_body: Body | None = None,
262
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
263
+ ) -> AsyncPaginator[VideoMetrics, AsyncVideosPage[VideoMetrics]]:
264
+ """List per-video totals.
265
+
266
+ Sort the entire filtered cohort by video_id, views,
267
+ unique_viewers, total_playing_time_ms or playback_score before pagination.
268
+ Defaults to video_id ascending. Missing scores come last; metric ties use
269
+ video_id ascending in both directions. Unique viewer counts cannot be added
270
+ across videos. Keep sort_by, order and filters unchanged with a cursor.
271
+
272
+ Args:
273
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
274
+
275
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
276
+ characters. Use country alongside city to distinguish places with the same name.
277
+ Missing locations do not match.
278
+
279
+ continent: Exact continent code from the local lookup. Missing locations do not match.
280
+
281
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
282
+ do not match.
283
+
284
+ cursor: Use next_cursor from the previous page. Keep the same filters, sort_by and
285
+ order. Video cursors from earlier versions are invalid; start a new pagination
286
+ sequence after upgrading.
287
+
288
+ device_type: Exact device class. unknown matches an explicit unknown value.
289
+
290
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
291
+ queries apply it to the selected view_started event. Must be before to.
292
+
293
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
294
+ quality and engagement support it only with group_by.
295
+
296
+ order: Sort direction. Events and videos default to asc; views default to desc. Events
297
+ sort by ingestion sequence. Videos and views sort by sort_by with missing values
298
+ last. View ties use view_id in the requested direction; video metric ties use
299
+ video_id ascending.
300
+
301
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
302
+
303
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
304
+ https://example.com. Metrics use the first retained view start; raw events use
305
+ each event context. Missing values do not match.
306
+
307
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
308
+ Filter by page_origin as well to distinguish identical paths on different sites.
309
+ Metrics use the first retained view start; raw events use each event context.
310
+ Missing values do not match.
311
+
312
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
313
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
314
+ start; raw events use each event's value.
315
+
316
+ sort_by: Rank all matching videos before pagination. Missing scores come last in both
317
+ directions. Metric ties use video_id ascending. Keep sort_by, order and filters
318
+ unchanged with a cursor.
319
+
320
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
321
+ for a subtitles track without a language. Metrics use the language showing on
322
+ the first retained view start; raw events use each event's value. Views without
323
+ subtitles at start do not match.
324
+
325
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
326
+ queries apply it to the selected view_started event.
327
+
328
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
329
+ lists match each event's own value. Missing/null user IDs do not match. Reports
330
+ with this filter read one stored row per view.
331
+
332
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
333
+
334
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
335
+ retained start; event lists match each event's own value. Views without a title
336
+ do not match. Reports with this filter read one stored row per view.
337
+
338
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
339
+
340
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
341
+ viewer IDs do not match.
342
+
343
+ extra_headers: Send extra headers
344
+
345
+ extra_query: Add additional query parameters to the request
346
+
347
+ extra_body: Add additional JSON properties to the request
348
+
349
+ timeout: Override the client-level default timeout for this request, in seconds
350
+ """
351
+ return self._get_api_list(
352
+ "/v1/videos",
353
+ page=AsyncVideosPage[VideoMetrics],
354
+ options=make_request_options(
355
+ extra_headers=extra_headers,
356
+ extra_query=extra_query,
357
+ extra_body=extra_body,
358
+ timeout=timeout,
359
+ query=maybe_transform(
360
+ {
361
+ "browser_name": browser_name,
362
+ "city": city,
363
+ "continent": continent,
364
+ "country": country,
365
+ "cursor": cursor,
366
+ "device_type": device_type,
367
+ "from_": from_,
368
+ "limit": limit,
369
+ "order": order,
370
+ "os_name": os_name,
371
+ "page_origin": page_origin,
372
+ "page_path": page_path,
373
+ "playback_rate": playback_rate,
374
+ "sort_by": sort_by,
375
+ "subtitle_language": subtitle_language,
376
+ "to": to,
377
+ "user_id": user_id,
378
+ "video_id": video_id,
379
+ "video_title": video_title,
380
+ "view_id": view_id,
381
+ "viewer_id": viewer_id,
382
+ },
383
+ video_list_params.VideoListParams,
384
+ ),
385
+ security={"secret_key": True},
386
+ ),
387
+ model=VideoMetrics,
388
+ )
389
+
390
+
391
+ class VideosResourceWithRawResponse:
392
+ def __init__(self, videos: VideosResource) -> None:
393
+ self._videos = videos
394
+
395
+ self.list = to_raw_response_wrapper(
396
+ videos.list,
397
+ )
398
+
399
+
400
+ class AsyncVideosResourceWithRawResponse:
401
+ def __init__(self, videos: AsyncVideosResource) -> None:
402
+ self._videos = videos
403
+
404
+ self.list = async_to_raw_response_wrapper(
405
+ videos.list,
406
+ )
407
+
408
+
409
+ class VideosResourceWithStreamingResponse:
410
+ def __init__(self, videos: VideosResource) -> None:
411
+ self._videos = videos
412
+
413
+ self.list = to_streamed_response_wrapper(
414
+ videos.list,
415
+ )
416
+
417
+
418
+ class AsyncVideosResourceWithStreamingResponse:
419
+ def __init__(self, videos: AsyncVideosResource) -> None:
420
+ self._videos = videos
421
+
422
+ self.list = async_to_streamed_response_wrapper(
423
+ videos.list,
424
+ )