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