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