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,377 @@
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 retention_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.retention_report import RetentionReport
24
+
25
+ __all__ = ["RetentionResource", "AsyncRetentionResource"]
26
+
27
+
28
+ class RetentionResource(SyncAPIResource):
29
+ """Private retained-event and view-cohort queries."""
30
+
31
+ @cached_property
32
+ def with_raw_response(self) -> RetentionResourceWithRawResponse:
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 RetentionResourceWithRawResponse(self)
40
+
41
+ @cached_property
42
+ def with_streaming_response(self) -> RetentionResourceWithStreamingResponse:
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 RetentionResourceWithStreamingResponse(self)
49
+
50
+ def retrieve(
51
+ self,
52
+ *,
53
+ video_id: str,
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
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
59
+ from_: Union[str, datetime] | Omit = omit,
60
+ os_name: str | Omit = omit,
61
+ page_origin: str | Omit = omit,
62
+ page_path: str | Omit = omit,
63
+ playback_rate: str | Omit = omit,
64
+ subtitle_language: str | Omit = omit,
65
+ to: Union[str, datetime] | Omit = omit,
66
+ user_id: str | Omit = omit,
67
+ video_title: str | Omit = omit,
68
+ view_id: str | Omit = omit,
69
+ viewer_id: str | Omit = omit,
70
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
71
+ # The extra values given here take precedence over values defined on the client or passed to this method.
72
+ extra_headers: Headers | None = None,
73
+ extra_query: Query | None = None,
74
+ extra_body: Body | None = None,
75
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
76
+ ) -> RetentionReport:
77
+ """Count views along the video using recorded played ranges.
78
+
79
+ Requires video_id.
80
+ Uses the final measurement, or the latest snapshot without an end event, for
81
+ each retained start matching the date and audience filters. Each attempt counts
82
+ once in each section it overlapped, including replays. Skipped sections do not
83
+ count. Older events without played ranges and attempts without a finite positive
84
+ duration are excluded from sample_views. Returns at most 200 consecutive
85
+ buckets, including zero counts, at a width of at least one second. This is media
86
+ position, not wall-clock time.
87
+
88
+ Args:
89
+ video_id: Video to report. Retention measures one video at a time.
90
+
91
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
92
+
93
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
94
+ characters. Use country alongside city to distinguish places with the same name.
95
+ Missing locations do not match.
96
+
97
+ continent: Exact continent code from the local lookup. Missing locations do not match.
98
+
99
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
100
+ do not match.
101
+
102
+ device_type: Exact device class. unknown matches an explicit unknown value.
103
+
104
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
105
+ queries apply it to the selected view_started event. Must be before to.
106
+
107
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
108
+
109
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
110
+ https://example.com. Metrics use the first retained view start; raw events use
111
+ each event context. Missing values do not match.
112
+
113
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
114
+ Filter by page_origin as well to distinguish identical paths on different sites.
115
+ Metrics use the first retained view start; raw events use each event context.
116
+ Missing values do not match.
117
+
118
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
119
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
120
+ start; raw events use each event's value.
121
+
122
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
123
+ for a subtitles track without a language. Metrics use the language showing on
124
+ the first retained view start; raw events use each event's value. Views without
125
+ subtitles at start do not match.
126
+
127
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
128
+ queries apply it to the selected view_started event.
129
+
130
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
131
+ lists match each event's own value. Missing/null user IDs do not match. Reports
132
+ with this filter read one stored row per view.
133
+
134
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
135
+ retained start; event lists match each event's own value. Views without a title
136
+ do not match. Reports with this filter read one stored row per view.
137
+
138
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
139
+
140
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
141
+ viewer IDs do not match.
142
+
143
+ extra_headers: Send extra headers
144
+
145
+ extra_query: Add additional query parameters to the request
146
+
147
+ extra_body: Add additional JSON properties to the request
148
+
149
+ timeout: Override the client-level default timeout for this request, in seconds
150
+ """
151
+ return self._get(
152
+ "/v1/retention",
153
+ options=make_request_options(
154
+ extra_headers=extra_headers,
155
+ extra_query=extra_query,
156
+ extra_body=extra_body,
157
+ timeout=timeout,
158
+ query=maybe_transform(
159
+ {
160
+ "video_id": video_id,
161
+ "browser_name": browser_name,
162
+ "city": city,
163
+ "continent": continent,
164
+ "country": country,
165
+ "device_type": device_type,
166
+ "from_": from_,
167
+ "os_name": os_name,
168
+ "page_origin": page_origin,
169
+ "page_path": page_path,
170
+ "playback_rate": playback_rate,
171
+ "subtitle_language": subtitle_language,
172
+ "to": to,
173
+ "user_id": user_id,
174
+ "video_title": video_title,
175
+ "view_id": view_id,
176
+ "viewer_id": viewer_id,
177
+ },
178
+ retention_retrieve_params.RetentionRetrieveParams,
179
+ ),
180
+ security={"secret_key": True},
181
+ ),
182
+ cast_to=RetentionReport,
183
+ )
184
+
185
+
186
+ class AsyncRetentionResource(AsyncAPIResource):
187
+ """Private retained-event and view-cohort queries."""
188
+
189
+ @cached_property
190
+ def with_raw_response(self) -> AsyncRetentionResourceWithRawResponse:
191
+ """
192
+ This property can be used as a prefix for any HTTP method call to return
193
+ the raw response object instead of the parsed content.
194
+
195
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
196
+ """
197
+ return AsyncRetentionResourceWithRawResponse(self)
198
+
199
+ @cached_property
200
+ def with_streaming_response(self) -> AsyncRetentionResourceWithStreamingResponse:
201
+ """
202
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
203
+
204
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
205
+ """
206
+ return AsyncRetentionResourceWithStreamingResponse(self)
207
+
208
+ async def retrieve(
209
+ self,
210
+ *,
211
+ video_id: str,
212
+ browser_name: str | Omit = omit,
213
+ city: str | Omit = omit,
214
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
215
+ country: str | Omit = omit,
216
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
217
+ from_: Union[str, datetime] | Omit = omit,
218
+ os_name: str | Omit = omit,
219
+ page_origin: str | Omit = omit,
220
+ page_path: str | Omit = omit,
221
+ playback_rate: str | Omit = omit,
222
+ subtitle_language: str | Omit = omit,
223
+ to: Union[str, datetime] | Omit = omit,
224
+ user_id: str | Omit = omit,
225
+ video_title: str | Omit = omit,
226
+ view_id: str | Omit = omit,
227
+ viewer_id: str | Omit = omit,
228
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
229
+ # The extra values given here take precedence over values defined on the client or passed to this method.
230
+ extra_headers: Headers | None = None,
231
+ extra_query: Query | None = None,
232
+ extra_body: Body | None = None,
233
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
234
+ ) -> RetentionReport:
235
+ """Count views along the video using recorded played ranges.
236
+
237
+ Requires video_id.
238
+ Uses the final measurement, or the latest snapshot without an end event, for
239
+ each retained start matching the date and audience filters. Each attempt counts
240
+ once in each section it overlapped, including replays. Skipped sections do not
241
+ count. Older events without played ranges and attempts without a finite positive
242
+ duration are excluded from sample_views. Returns at most 200 consecutive
243
+ buckets, including zero counts, at a width of at least one second. This is media
244
+ position, not wall-clock time.
245
+
246
+ Args:
247
+ video_id: Video to report. Retention measures one video at a time.
248
+
249
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
250
+
251
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
252
+ characters. Use country alongside city to distinguish places with the same name.
253
+ Missing locations do not match.
254
+
255
+ continent: Exact continent code from the local lookup. Missing locations do not match.
256
+
257
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
258
+ do not match.
259
+
260
+ device_type: Exact device class. unknown matches an explicit unknown value.
261
+
262
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
263
+ queries apply it to the selected view_started event. Must be before to.
264
+
265
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
266
+
267
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
268
+ https://example.com. Metrics use the first retained view start; raw events use
269
+ each event context. Missing values do not match.
270
+
271
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
272
+ Filter by page_origin as well to distinguish identical paths on different sites.
273
+ Metrics use the first retained view start; raw events use each event context.
274
+ Missing values do not match.
275
+
276
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
277
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
278
+ start; raw events use each event's value.
279
+
280
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
281
+ for a subtitles track without a language. Metrics use the language showing on
282
+ the first retained view start; raw events use each event's value. Views without
283
+ subtitles at start do not match.
284
+
285
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
286
+ queries apply it to the selected view_started event.
287
+
288
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
289
+ lists match each event's own value. Missing/null user IDs do not match. Reports
290
+ with this filter read one stored row per view.
291
+
292
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
293
+ retained start; event lists match each event's own value. Views without a title
294
+ do not match. Reports with this filter read one stored row per view.
295
+
296
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
297
+
298
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
299
+ viewer IDs do not match.
300
+
301
+ extra_headers: Send extra headers
302
+
303
+ extra_query: Add additional query parameters to the request
304
+
305
+ extra_body: Add additional JSON properties to the request
306
+
307
+ timeout: Override the client-level default timeout for this request, in seconds
308
+ """
309
+ return await self._get(
310
+ "/v1/retention",
311
+ options=make_request_options(
312
+ extra_headers=extra_headers,
313
+ extra_query=extra_query,
314
+ extra_body=extra_body,
315
+ timeout=timeout,
316
+ query=await async_maybe_transform(
317
+ {
318
+ "video_id": video_id,
319
+ "browser_name": browser_name,
320
+ "city": city,
321
+ "continent": continent,
322
+ "country": country,
323
+ "device_type": device_type,
324
+ "from_": from_,
325
+ "os_name": os_name,
326
+ "page_origin": page_origin,
327
+ "page_path": page_path,
328
+ "playback_rate": playback_rate,
329
+ "subtitle_language": subtitle_language,
330
+ "to": to,
331
+ "user_id": user_id,
332
+ "video_title": video_title,
333
+ "view_id": view_id,
334
+ "viewer_id": viewer_id,
335
+ },
336
+ retention_retrieve_params.RetentionRetrieveParams,
337
+ ),
338
+ security={"secret_key": True},
339
+ ),
340
+ cast_to=RetentionReport,
341
+ )
342
+
343
+
344
+ class RetentionResourceWithRawResponse:
345
+ def __init__(self, retention: RetentionResource) -> None:
346
+ self._retention = retention
347
+
348
+ self.retrieve = to_raw_response_wrapper(
349
+ retention.retrieve,
350
+ )
351
+
352
+
353
+ class AsyncRetentionResourceWithRawResponse:
354
+ def __init__(self, retention: AsyncRetentionResource) -> None:
355
+ self._retention = retention
356
+
357
+ self.retrieve = async_to_raw_response_wrapper(
358
+ retention.retrieve,
359
+ )
360
+
361
+
362
+ class RetentionResourceWithStreamingResponse:
363
+ def __init__(self, retention: RetentionResource) -> None:
364
+ self._retention = retention
365
+
366
+ self.retrieve = to_streamed_response_wrapper(
367
+ retention.retrieve,
368
+ )
369
+
370
+
371
+ class AsyncRetentionResourceWithStreamingResponse:
372
+ def __init__(self, retention: AsyncRetentionResource) -> None:
373
+ self._retention = retention
374
+
375
+ self.retrieve = async_to_streamed_response_wrapper(
376
+ retention.retrieve,
377
+ )