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,562 @@
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 event_list_params, event_ingest_params
12
+ from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
13
+ from .._utils import is_given, maybe_transform, strip_not_given, 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 ..pagination import SyncEventsPage, AsyncEventsPage
23
+ from .._base_client import AsyncPaginator, make_request_options
24
+ from ..types.stored_event import StoredEvent
25
+ from ..types.analytics_event_param import AnalyticsEventParam
26
+ from ..types.event_ingest_response import EventIngestResponse
27
+
28
+ __all__ = ["EventsResource", "AsyncEventsResource"]
29
+
30
+
31
+ class EventsResource(SyncAPIResource):
32
+ @cached_property
33
+ def with_raw_response(self) -> EventsResourceWithRawResponse:
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 EventsResourceWithRawResponse(self)
41
+
42
+ @cached_property
43
+ def with_streaming_response(self) -> EventsResourceWithStreamingResponse:
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 EventsResourceWithStreamingResponse(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
+ event_name: Literal[
61
+ "chunkify.video.view_started",
62
+ "chunkify.video.view_snapshot",
63
+ "chunkify.video.playback_error",
64
+ "chunkify.video.view_ended",
65
+ "chunkify.video.playback_state_changed",
66
+ "chunkify.video.rendition_changed",
67
+ "chunkify.video.seek_completed",
68
+ "chunkify.video.subtitle_changed",
69
+ "chunkify.video.playback_rate_changed",
70
+ ]
71
+ | Omit = omit,
72
+ from_: Union[str, datetime] | Omit = omit,
73
+ limit: int | Omit = omit,
74
+ order: Literal["asc", "desc"] | Omit = omit,
75
+ os_name: str | Omit = omit,
76
+ page_origin: str | Omit = omit,
77
+ page_path: str | Omit = omit,
78
+ playback_rate: str | Omit = omit,
79
+ subtitle_language: str | Omit = omit,
80
+ to: Union[str, datetime] | Omit = omit,
81
+ user_id: str | Omit = omit,
82
+ video_id: str | Omit = omit,
83
+ video_title: str | Omit = omit,
84
+ view_id: str | Omit = omit,
85
+ viewer_id: str | Omit = omit,
86
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
87
+ # The extra values given here take precedence over values defined on the client or passed to this method.
88
+ extra_headers: Headers | None = None,
89
+ extra_query: Query | None = None,
90
+ extra_body: Body | None = None,
91
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
92
+ ) -> SyncEventsPage[StoredEvent]:
93
+ """List project events with filters and pagination.
94
+
95
+ Use order=desc for the newest
96
+ events.
97
+
98
+ Args:
99
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
100
+
101
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
102
+ characters. Use country alongside city to distinguish places with the same name.
103
+ Missing locations do not match.
104
+
105
+ continent: Exact continent code from the local lookup. Missing locations do not match.
106
+
107
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
108
+ do not match.
109
+
110
+ cursor: Use next_cursor from the previous page. Keep the same filters, sort_by and
111
+ order. Video cursors from earlier versions are invalid; start a new pagination
112
+ sequence after upgrading.
113
+
114
+ device_type: Exact device class. unknown matches an explicit unknown value.
115
+
116
+ event_name: Raw-event queries only. Summaries and videos reject this parameter.
117
+
118
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
119
+ queries apply it to the selected view_started event. Must be before to.
120
+
121
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
122
+ quality and engagement support it only with group_by.
123
+
124
+ order: Sort direction. Events and videos default to asc; views default to desc. Events
125
+ sort by ingestion sequence. Videos and views sort by sort_by with missing values
126
+ last. View ties use view_id in the requested direction; video metric ties use
127
+ video_id ascending.
128
+
129
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
130
+
131
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
132
+ https://example.com. Metrics use the first retained view start; raw events use
133
+ each event context. Missing values do not match.
134
+
135
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
136
+ Filter by page_origin as well to distinguish identical paths on different sites.
137
+ Metrics use the first retained view start; raw events use each event context.
138
+ Missing values do not match.
139
+
140
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
141
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
142
+ start; raw events use each event's value.
143
+
144
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
145
+ for a subtitles track without a language. Metrics use the language showing on
146
+ the first retained view start; raw events use each event's value. Views without
147
+ subtitles at start do not match.
148
+
149
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
150
+ queries apply it to the selected view_started event.
151
+
152
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
153
+ lists match each event's own value. Missing/null user IDs do not match. Reports
154
+ with this filter read one stored row per view.
155
+
156
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
157
+
158
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
159
+ retained start; event lists match each event's own value. Views without a title
160
+ do not match. Reports with this filter read one stored row per view.
161
+
162
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
163
+
164
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
165
+ viewer IDs do not match.
166
+
167
+ extra_headers: Send extra headers
168
+
169
+ extra_query: Add additional query parameters to the request
170
+
171
+ extra_body: Add additional JSON properties to the request
172
+
173
+ timeout: Override the client-level default timeout for this request, in seconds
174
+ """
175
+ return self._get_api_list(
176
+ "/v1/events",
177
+ page=SyncEventsPage[StoredEvent],
178
+ options=make_request_options(
179
+ extra_headers=extra_headers,
180
+ extra_query=extra_query,
181
+ extra_body=extra_body,
182
+ timeout=timeout,
183
+ query=maybe_transform(
184
+ {
185
+ "browser_name": browser_name,
186
+ "city": city,
187
+ "continent": continent,
188
+ "country": country,
189
+ "cursor": cursor,
190
+ "device_type": device_type,
191
+ "event_name": event_name,
192
+ "from_": from_,
193
+ "limit": limit,
194
+ "order": order,
195
+ "os_name": os_name,
196
+ "page_origin": page_origin,
197
+ "page_path": page_path,
198
+ "playback_rate": playback_rate,
199
+ "subtitle_language": subtitle_language,
200
+ "to": to,
201
+ "user_id": user_id,
202
+ "video_id": video_id,
203
+ "video_title": video_title,
204
+ "view_id": view_id,
205
+ "viewer_id": viewer_id,
206
+ },
207
+ event_list_params.EventListParams,
208
+ ),
209
+ security={"secret_key": True},
210
+ ),
211
+ model=StoredEvent,
212
+ )
213
+
214
+ def ingest(
215
+ self,
216
+ *,
217
+ event: AnalyticsEventParam,
218
+ content_encoding: Literal["identity"] | Omit = omit,
219
+ origin: str | Omit = omit,
220
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
221
+ # The extra values given here take precedence over values defined on the client or passed to this method.
222
+ extra_headers: Headers | None = None,
223
+ extra_query: Query | None = None,
224
+ extra_body: Body | None = None,
225
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
226
+ ) -> EventIngestResponse:
227
+ """Send one playback event using a public key.
228
+
229
+ Success confirms storage completed.
230
+
231
+ Configure the client with a public ingestion key for this method. The SDK sends
232
+ the event you supply; it does not collect playback events automatically. For
233
+ automatic browser player tracking, use `@chunkify/player-analytics`.
234
+
235
+ Args:
236
+ event: A schema version 1 playback event. Extra properties are preserved.
237
+
238
+ extra_headers: Send extra headers
239
+
240
+ extra_query: Add additional query parameters to the request
241
+
242
+ extra_body: Add additional JSON properties to the request
243
+
244
+ timeout: Override the client-level default timeout for this request, in seconds
245
+ """
246
+ extra_headers = {
247
+ **strip_not_given(
248
+ {
249
+ "Content-Encoding": str(content_encoding) if is_given(content_encoding) else not_given,
250
+ "Origin": origin,
251
+ }
252
+ ),
253
+ **(extra_headers or {}),
254
+ }
255
+ return cast(
256
+ EventIngestResponse,
257
+ self._post(
258
+ "/v1/events",
259
+ body=maybe_transform(event, event_ingest_params.EventIngestParams),
260
+ options=make_request_options(
261
+ extra_headers=extra_headers,
262
+ extra_query=extra_query,
263
+ extra_body=extra_body,
264
+ timeout=timeout,
265
+ security={"public_key": True},
266
+ ),
267
+ cast_to=cast(
268
+ Any, EventIngestResponse
269
+ ), # Union types cannot be passed in as arguments in the type system
270
+ ),
271
+ )
272
+
273
+
274
+ class AsyncEventsResource(AsyncAPIResource):
275
+ @cached_property
276
+ def with_raw_response(self) -> AsyncEventsResourceWithRawResponse:
277
+ """
278
+ This property can be used as a prefix for any HTTP method call to return
279
+ the raw response object instead of the parsed content.
280
+
281
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
282
+ """
283
+ return AsyncEventsResourceWithRawResponse(self)
284
+
285
+ @cached_property
286
+ def with_streaming_response(self) -> AsyncEventsResourceWithStreamingResponse:
287
+ """
288
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
289
+
290
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
291
+ """
292
+ return AsyncEventsResourceWithStreamingResponse(self)
293
+
294
+ def list(
295
+ self,
296
+ *,
297
+ browser_name: str | Omit = omit,
298
+ city: str | Omit = omit,
299
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
300
+ country: str | Omit = omit,
301
+ cursor: str | Omit = omit,
302
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
303
+ event_name: Literal[
304
+ "chunkify.video.view_started",
305
+ "chunkify.video.view_snapshot",
306
+ "chunkify.video.playback_error",
307
+ "chunkify.video.view_ended",
308
+ "chunkify.video.playback_state_changed",
309
+ "chunkify.video.rendition_changed",
310
+ "chunkify.video.seek_completed",
311
+ "chunkify.video.subtitle_changed",
312
+ "chunkify.video.playback_rate_changed",
313
+ ]
314
+ | Omit = omit,
315
+ from_: Union[str, datetime] | Omit = omit,
316
+ limit: int | Omit = omit,
317
+ order: Literal["asc", "desc"] | Omit = omit,
318
+ os_name: str | Omit = omit,
319
+ page_origin: str | Omit = omit,
320
+ page_path: str | Omit = omit,
321
+ playback_rate: str | Omit = omit,
322
+ subtitle_language: str | Omit = omit,
323
+ to: Union[str, datetime] | Omit = omit,
324
+ user_id: str | Omit = omit,
325
+ video_id: str | Omit = omit,
326
+ video_title: str | Omit = omit,
327
+ view_id: str | Omit = omit,
328
+ viewer_id: str | Omit = omit,
329
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
330
+ # The extra values given here take precedence over values defined on the client or passed to this method.
331
+ extra_headers: Headers | None = None,
332
+ extra_query: Query | None = None,
333
+ extra_body: Body | None = None,
334
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
335
+ ) -> AsyncPaginator[StoredEvent, AsyncEventsPage[StoredEvent]]:
336
+ """List project events with filters and pagination.
337
+
338
+ Use order=desc for the newest
339
+ events.
340
+
341
+ Args:
342
+ browser_name: Exact browser name, such as Chrome. Missing values do not match.
343
+
344
+ city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
345
+ characters. Use country alongside city to distinguish places with the same name.
346
+ Missing locations do not match.
347
+
348
+ continent: Exact continent code from the local lookup. Missing locations do not match.
349
+
350
+ country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
351
+ do not match.
352
+
353
+ cursor: Use next_cursor from the previous page. Keep the same filters, sort_by and
354
+ order. Video cursors from earlier versions are invalid; start a new pagination
355
+ sequence after upgrading.
356
+
357
+ device_type: Exact device class. unknown matches an explicit unknown value.
358
+
359
+ event_name: Raw-event queries only. Summaries and videos reject this parameter.
360
+
361
+ from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
362
+ queries apply it to the selected view_started event. Must be before to.
363
+
364
+ limit: Maximum rows on this page. Events and videos always support pagination; summary,
365
+ quality and engagement support it only with group_by.
366
+
367
+ order: Sort direction. Events and videos default to asc; views default to desc. Events
368
+ sort by ingestion sequence. Videos and views sort by sort_by with missing values
369
+ last. View ties use view_id in the requested direction; video metric ties use
370
+ video_id ascending.
371
+
372
+ os_name: Exact operating-system name, such as macOS. Missing values do not match.
373
+
374
+ page_origin: Exact, case-sensitive page origin captured by the player, such as
375
+ https://example.com. Metrics use the first retained view start; raw events use
376
+ each event context. Missing values do not match.
377
+
378
+ page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
379
+ Filter by page_origin as well to distinguish identical paths on different sites.
380
+ Metrics use the first retained view start; raw events use each event context.
381
+ Missing values do not match.
382
+
383
+ playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
384
+ 2.0 and 2 are the same rate. Metrics use the rate on the first retained view
385
+ start; raw events use each event's value.
386
+
387
+ subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
388
+ for a subtitles track without a language. Metrics use the language showing on
389
+ the first retained view start; raw events use each event's value. Views without
390
+ subtitles at start do not match.
391
+
392
+ to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
393
+ queries apply it to the selected view_started event.
394
+
395
+ user_id: Exact integrator-supplied user ID. Selects views by their start event; event
396
+ lists match each event's own value. Missing/null user IDs do not match. Reports
397
+ with this filter read one stored row per view.
398
+
399
+ video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
400
+
401
+ video_title: Exact, case-sensitive video title. Selects views by the title on their first
402
+ retained start; event lists match each event's own value. Views without a title
403
+ do not match. Reports with this filter read one stored row per view.
404
+
405
+ view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
406
+
407
+ viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
408
+ viewer IDs do not match.
409
+
410
+ extra_headers: Send extra headers
411
+
412
+ extra_query: Add additional query parameters to the request
413
+
414
+ extra_body: Add additional JSON properties to the request
415
+
416
+ timeout: Override the client-level default timeout for this request, in seconds
417
+ """
418
+ return self._get_api_list(
419
+ "/v1/events",
420
+ page=AsyncEventsPage[StoredEvent],
421
+ options=make_request_options(
422
+ extra_headers=extra_headers,
423
+ extra_query=extra_query,
424
+ extra_body=extra_body,
425
+ timeout=timeout,
426
+ query=maybe_transform(
427
+ {
428
+ "browser_name": browser_name,
429
+ "city": city,
430
+ "continent": continent,
431
+ "country": country,
432
+ "cursor": cursor,
433
+ "device_type": device_type,
434
+ "event_name": event_name,
435
+ "from_": from_,
436
+ "limit": limit,
437
+ "order": order,
438
+ "os_name": os_name,
439
+ "page_origin": page_origin,
440
+ "page_path": page_path,
441
+ "playback_rate": playback_rate,
442
+ "subtitle_language": subtitle_language,
443
+ "to": to,
444
+ "user_id": user_id,
445
+ "video_id": video_id,
446
+ "video_title": video_title,
447
+ "view_id": view_id,
448
+ "viewer_id": viewer_id,
449
+ },
450
+ event_list_params.EventListParams,
451
+ ),
452
+ security={"secret_key": True},
453
+ ),
454
+ model=StoredEvent,
455
+ )
456
+
457
+ async def ingest(
458
+ self,
459
+ *,
460
+ event: AnalyticsEventParam,
461
+ content_encoding: Literal["identity"] | Omit = omit,
462
+ origin: str | Omit = omit,
463
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
464
+ # The extra values given here take precedence over values defined on the client or passed to this method.
465
+ extra_headers: Headers | None = None,
466
+ extra_query: Query | None = None,
467
+ extra_body: Body | None = None,
468
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
469
+ ) -> EventIngestResponse:
470
+ """Send one playback event using a public key.
471
+
472
+ Success confirms storage completed.
473
+
474
+ Configure the client with a public ingestion key for this method. The SDK sends
475
+ the event you supply; it does not collect playback events automatically. For
476
+ automatic browser player tracking, use `@chunkify/player-analytics`.
477
+
478
+ Args:
479
+ event: A schema version 1 playback event. Extra properties are preserved.
480
+
481
+ extra_headers: Send extra headers
482
+
483
+ extra_query: Add additional query parameters to the request
484
+
485
+ extra_body: Add additional JSON properties to the request
486
+
487
+ timeout: Override the client-level default timeout for this request, in seconds
488
+ """
489
+ extra_headers = {
490
+ **strip_not_given(
491
+ {
492
+ "Content-Encoding": str(content_encoding) if is_given(content_encoding) else not_given,
493
+ "Origin": origin,
494
+ }
495
+ ),
496
+ **(extra_headers or {}),
497
+ }
498
+ return cast(
499
+ EventIngestResponse,
500
+ await self._post(
501
+ "/v1/events",
502
+ body=await async_maybe_transform(event, event_ingest_params.EventIngestParams),
503
+ options=make_request_options(
504
+ extra_headers=extra_headers,
505
+ extra_query=extra_query,
506
+ extra_body=extra_body,
507
+ timeout=timeout,
508
+ security={"public_key": True},
509
+ ),
510
+ cast_to=cast(
511
+ Any, EventIngestResponse
512
+ ), # Union types cannot be passed in as arguments in the type system
513
+ ),
514
+ )
515
+
516
+
517
+ class EventsResourceWithRawResponse:
518
+ def __init__(self, events: EventsResource) -> None:
519
+ self._events = events
520
+
521
+ self.list = to_raw_response_wrapper(
522
+ events.list,
523
+ )
524
+ self.ingest = to_raw_response_wrapper(
525
+ events.ingest,
526
+ )
527
+
528
+
529
+ class AsyncEventsResourceWithRawResponse:
530
+ def __init__(self, events: AsyncEventsResource) -> None:
531
+ self._events = events
532
+
533
+ self.list = async_to_raw_response_wrapper(
534
+ events.list,
535
+ )
536
+ self.ingest = async_to_raw_response_wrapper(
537
+ events.ingest,
538
+ )
539
+
540
+
541
+ class EventsResourceWithStreamingResponse:
542
+ def __init__(self, events: EventsResource) -> None:
543
+ self._events = events
544
+
545
+ self.list = to_streamed_response_wrapper(
546
+ events.list,
547
+ )
548
+ self.ingest = to_streamed_response_wrapper(
549
+ events.ingest,
550
+ )
551
+
552
+
553
+ class AsyncEventsResourceWithStreamingResponse:
554
+ def __init__(self, events: AsyncEventsResource) -> None:
555
+ self._events = events
556
+
557
+ self.list = async_to_streamed_response_wrapper(
558
+ events.list,
559
+ )
560
+ self.ingest = async_to_streamed_response_wrapper(
561
+ events.ingest,
562
+ )