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,389 @@
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 subtitle_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.subtitle_report import SubtitleReport
24
+
25
+ __all__ = ["SubtitlesResource", "AsyncSubtitlesResource"]
26
+
27
+
28
+ class SubtitlesResource(SyncAPIResource):
29
+ """Private retained-event and view-cohort queries."""
30
+
31
+ @cached_property
32
+ def with_raw_response(self) -> SubtitlesResourceWithRawResponse:
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 SubtitlesResourceWithRawResponse(self)
40
+
41
+ @cached_property
42
+ def with_streaming_response(self) -> SubtitlesResourceWithStreamingResponse:
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 SubtitlesResourceWithStreamingResponse(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
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
58
+ from_: Union[str, datetime] | Omit = omit,
59
+ limit: int | 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_id: str | Omit = omit,
68
+ video_title: str | Omit = omit,
69
+ view_id: str | Omit = omit,
70
+ viewer_id: str | Omit = omit,
71
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
72
+ # The extra values given here take precedence over values defined on the client or passed to this method.
73
+ extra_headers: Headers | None = None,
74
+ extra_query: Query | None = None,
75
+ extra_body: Body | None = None,
76
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
77
+ ) -> SubtitleReport:
78
+ """Summarize watch time per subtitle language.
79
+
80
+ Expand each view's cumulative
81
+ subtitle_playing_time array once; a null language is time with subtitles off.
82
+ Use only the selected final event, or latest snapshot when no final exists, for
83
+ the filtered view-start cohort. Missing or empty measurements contribute no
84
+ time; older SDKs send none. Rank by playing time descending, then value
85
+ ascending with null first; limit bounds returned rows only, while totals cover
86
+ every matching row. Views can contribute to several rows and must not be summed.
87
+ No cursor, group_by, sort_by or order. Export resource=subtitles includes all
88
+ matching rows.
89
+
90
+ Args:
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
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
108
+ quality and engagement support it only with group_by.
109
+
110
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
111
+
112
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
113
+ https://example.com. Metrics use the first retained view start; raw events use
114
+ each event context. Missing values do not match.
115
+
116
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
117
+ Filter by page_origin as well to distinguish identical paths on different sites.
118
+ Metrics use the first retained view start; raw events use each event context.
119
+ Missing values do not match.
120
+
121
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
122
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
123
+ start; raw events use each event's value.
124
+
125
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
126
+ for a subtitles track without a language. Metrics use the language showing on
127
+ the first retained view start; raw events use each event's value. Views without
128
+ subtitles at start do not match.
129
+
130
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
131
+ queries apply it to the selected view_started event.
132
+
133
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
134
+ lists match each event's own value. Missing/null user IDs do not match. Reports
135
+ with this filter read one stored row per view.
136
+
137
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
138
+
139
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
140
+ retained start; event lists match each event's own value. Views without a title
141
+ do not match. Reports with this filter read one stored row per view.
142
+
143
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
144
+
145
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
146
+ viewer IDs do not match.
147
+
148
+ extra_headers: Send extra headers
149
+
150
+ extra_query: Add additional query parameters to the request
151
+
152
+ extra_body: Add additional JSON properties to the request
153
+
154
+ timeout: Override the client-level default timeout for this request, in seconds
155
+ """
156
+ return self._get(
157
+ "/v1/subtitles",
158
+ options=make_request_options(
159
+ extra_headers=extra_headers,
160
+ extra_query=extra_query,
161
+ extra_body=extra_body,
162
+ timeout=timeout,
163
+ query=maybe_transform(
164
+ {
165
+ "browser_name": browser_name,
166
+ "city": city,
167
+ "continent": continent,
168
+ "country": country,
169
+ "device_type": device_type,
170
+ "from_": from_,
171
+ "limit": limit,
172
+ "os_name": os_name,
173
+ "page_origin": page_origin,
174
+ "page_path": page_path,
175
+ "playback_rate": playback_rate,
176
+ "subtitle_language": subtitle_language,
177
+ "to": to,
178
+ "user_id": user_id,
179
+ "video_id": video_id,
180
+ "video_title": video_title,
181
+ "view_id": view_id,
182
+ "viewer_id": viewer_id,
183
+ },
184
+ subtitle_retrieve_params.SubtitleRetrieveParams,
185
+ ),
186
+ security={"secret_key": True},
187
+ ),
188
+ cast_to=SubtitleReport,
189
+ )
190
+
191
+
192
+ class AsyncSubtitlesResource(AsyncAPIResource):
193
+ """Private retained-event and view-cohort queries."""
194
+
195
+ @cached_property
196
+ def with_raw_response(self) -> AsyncSubtitlesResourceWithRawResponse:
197
+ """
198
+ This property can be used as a prefix for any HTTP method call to return
199
+ the raw response object instead of the parsed content.
200
+
201
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
202
+ """
203
+ return AsyncSubtitlesResourceWithRawResponse(self)
204
+
205
+ @cached_property
206
+ def with_streaming_response(self) -> AsyncSubtitlesResourceWithStreamingResponse:
207
+ """
208
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
209
+
210
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
211
+ """
212
+ return AsyncSubtitlesResourceWithStreamingResponse(self)
213
+
214
+ async def retrieve(
215
+ self,
216
+ *,
217
+ browser_name: str | Omit = omit,
218
+ city: str | Omit = omit,
219
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
220
+ country: str | Omit = omit,
221
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
222
+ from_: Union[str, datetime] | Omit = omit,
223
+ limit: int | Omit = omit,
224
+ os_name: str | Omit = omit,
225
+ page_origin: str | Omit = omit,
226
+ page_path: str | Omit = omit,
227
+ playback_rate: str | Omit = omit,
228
+ subtitle_language: str | Omit = omit,
229
+ to: Union[str, datetime] | Omit = omit,
230
+ user_id: str | Omit = omit,
231
+ video_id: str | Omit = omit,
232
+ video_title: str | Omit = omit,
233
+ view_id: str | Omit = omit,
234
+ viewer_id: str | Omit = omit,
235
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
236
+ # The extra values given here take precedence over values defined on the client or passed to this method.
237
+ extra_headers: Headers | None = None,
238
+ extra_query: Query | None = None,
239
+ extra_body: Body | None = None,
240
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
241
+ ) -> SubtitleReport:
242
+ """Summarize watch time per subtitle language.
243
+
244
+ Expand each view's cumulative
245
+ subtitle_playing_time array once; a null language is time with subtitles off.
246
+ Use only the selected final event, or latest snapshot when no final exists, for
247
+ the filtered view-start cohort. Missing or empty measurements contribute no
248
+ time; older SDKs send none. Rank by playing time descending, then value
249
+ ascending with null first; limit bounds returned rows only, while totals cover
250
+ every matching row. Views can contribute to several rows and must not be summed.
251
+ No cursor, group_by, sort_by or order. Export resource=subtitles includes all
252
+ matching rows.
253
+
254
+ Args:
255
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
256
+
257
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
258
+ characters. Use country alongside city to distinguish places with the same name.
259
+ Missing locations do not match.
260
+
261
+ continent: Exact continent code from the local lookup. Missing locations do not match.
262
+
263
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
264
+ do not match.
265
+
266
+ device_type: Exact device class. unknown matches an explicit unknown value.
267
+
268
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
269
+ queries apply it to the selected view_started event. Must be before to.
270
+
271
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
272
+ quality and engagement support it only with group_by.
273
+
274
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
275
+
276
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
277
+ https://example.com. Metrics use the first retained view start; raw events use
278
+ each event context. Missing values do not match.
279
+
280
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
281
+ Filter by page_origin as well to distinguish identical paths on different sites.
282
+ Metrics use the first retained view start; raw events use each event context.
283
+ Missing values do not match.
284
+
285
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
286
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
287
+ start; raw events use each event's value.
288
+
289
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
290
+ for a subtitles track without a language. Metrics use the language showing on
291
+ the first retained view start; raw events use each event's value. Views without
292
+ subtitles at start do not match.
293
+
294
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
295
+ queries apply it to the selected view_started event.
296
+
297
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
298
+ lists match each event's own value. Missing/null user IDs do not match. Reports
299
+ with this filter read one stored row per view.
300
+
301
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
302
+
303
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
304
+ retained start; event lists match each event's own value. Views without a title
305
+ do not match. Reports with this filter read one stored row per view.
306
+
307
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
308
+
309
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
310
+ viewer IDs do not match.
311
+
312
+ extra_headers: Send extra headers
313
+
314
+ extra_query: Add additional query parameters to the request
315
+
316
+ extra_body: Add additional JSON properties to the request
317
+
318
+ timeout: Override the client-level default timeout for this request, in seconds
319
+ """
320
+ return await self._get(
321
+ "/v1/subtitles",
322
+ options=make_request_options(
323
+ extra_headers=extra_headers,
324
+ extra_query=extra_query,
325
+ extra_body=extra_body,
326
+ timeout=timeout,
327
+ query=await async_maybe_transform(
328
+ {
329
+ "browser_name": browser_name,
330
+ "city": city,
331
+ "continent": continent,
332
+ "country": country,
333
+ "device_type": device_type,
334
+ "from_": from_,
335
+ "limit": limit,
336
+ "os_name": os_name,
337
+ "page_origin": page_origin,
338
+ "page_path": page_path,
339
+ "playback_rate": playback_rate,
340
+ "subtitle_language": subtitle_language,
341
+ "to": to,
342
+ "user_id": user_id,
343
+ "video_id": video_id,
344
+ "video_title": video_title,
345
+ "view_id": view_id,
346
+ "viewer_id": viewer_id,
347
+ },
348
+ subtitle_retrieve_params.SubtitleRetrieveParams,
349
+ ),
350
+ security={"secret_key": True},
351
+ ),
352
+ cast_to=SubtitleReport,
353
+ )
354
+
355
+
356
+ class SubtitlesResourceWithRawResponse:
357
+ def __init__(self, subtitles: SubtitlesResource) -> None:
358
+ self._subtitles = subtitles
359
+
360
+ self.retrieve = to_raw_response_wrapper(
361
+ subtitles.retrieve,
362
+ )
363
+
364
+
365
+ class AsyncSubtitlesResourceWithRawResponse:
366
+ def __init__(self, subtitles: AsyncSubtitlesResource) -> None:
367
+ self._subtitles = subtitles
368
+
369
+ self.retrieve = async_to_raw_response_wrapper(
370
+ subtitles.retrieve,
371
+ )
372
+
373
+
374
+ class SubtitlesResourceWithStreamingResponse:
375
+ def __init__(self, subtitles: SubtitlesResource) -> None:
376
+ self._subtitles = subtitles
377
+
378
+ self.retrieve = to_streamed_response_wrapper(
379
+ subtitles.retrieve,
380
+ )
381
+
382
+
383
+ class AsyncSubtitlesResourceWithStreamingResponse:
384
+ def __init__(self, subtitles: AsyncSubtitlesResource) -> None:
385
+ self._subtitles = subtitles
386
+
387
+ self.retrieve = async_to_streamed_response_wrapper(
388
+ subtitles.retrieve,
389
+ )