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,69 @@
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 typing_extensions import Literal, Required, TypedDict
7
+
8
+ __all__ = ["ExportListColumnsParams"]
9
+
10
+
11
+ class ExportListColumnsParams(TypedDict, total=False):
12
+ resource: Required[
13
+ Literal[
14
+ "summary",
15
+ "quality",
16
+ "engagement",
17
+ "timeseries",
18
+ "videos",
19
+ "events",
20
+ "views",
21
+ "errors",
22
+ "dimensions",
23
+ "renditions",
24
+ "subtitles",
25
+ "playback_rates",
26
+ "retention",
27
+ ]
28
+ ]
29
+ """Report whose CSV columns to list."""
30
+
31
+ group_by: Union[
32
+ Literal[
33
+ "browser_name",
34
+ "os_name",
35
+ "device_type",
36
+ "continent",
37
+ "country",
38
+ "city",
39
+ "page_origin",
40
+ "page_path",
41
+ "subtitle_language",
42
+ "playback_rate",
43
+ "video_title",
44
+ "user_id",
45
+ ],
46
+ str,
47
+ ]
48
+ """Optional on summary, quality and engagement.
49
+
50
+ Group views by this field on their first retained start. Missing, null and
51
+ nonstring context forms a null group; the literal device type unknown stays
52
+ separate. Groups sort by views descending, then value ascending with null first
53
+ for ties. Pagination is available only with group_by. Location uses the first
54
+ retained start too. City groups use the stored name; filter by country to avoid
55
+ combining names shared by different countries. Page groups use the first
56
+ retained start even if playback continues after navigation. Filter by
57
+ page_origin when grouping page_path to distinguish identical paths on different
58
+ sites. video_title groups by the title on each view's first retained start, so a
59
+ renamed video counts each view under the title it started with. user_id groups
60
+ by the user ID on each view's first retained start. Use custom.<key>, such as
61
+ custom.plan, to group by a custom dimension; views without the key form the null
62
+ group.
63
+ """
64
+
65
+ kind: Literal["summary", "quality", "engagement"]
66
+ """Metric set for every time bucket.
67
+
68
+ Uses the same calculations and sample counts as the corresponding totals route.
69
+ """
@@ -0,0 +1,141 @@
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, Annotated, TypedDict
8
+
9
+ from .._utils import PropertyInfo
10
+
11
+ __all__ = ["ExportQueryParam"]
12
+
13
+ _ExportQueryParamReservedKeywords = TypedDict(
14
+ "_ExportQueryParamReservedKeywords",
15
+ {
16
+ "from": Union[str, datetime],
17
+ },
18
+ total=False,
19
+ )
20
+
21
+
22
+ class ExportQueryParam(_ExportQueryParamReservedKeywords, total=False):
23
+ browser_name: str
24
+
25
+ city: str
26
+
27
+ continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"]
28
+
29
+ country: str
30
+
31
+ device_type: Literal["desktop", "mobile", "tablet", "unknown"]
32
+
33
+ dimension: Union[
34
+ Literal[
35
+ "browser_name",
36
+ "os_name",
37
+ "device_type",
38
+ "video_id",
39
+ "viewer_id",
40
+ "user_id",
41
+ "video_title",
42
+ "continent",
43
+ "country",
44
+ "city",
45
+ "page_origin",
46
+ "page_path",
47
+ "subtitle_language",
48
+ "playback_rate",
49
+ "custom_keys",
50
+ ],
51
+ str,
52
+ ]
53
+ """One custom dimension's values, such as custom.plan."""
54
+
55
+ event_name: Literal[
56
+ "chunkify.video.view_started",
57
+ "chunkify.video.view_snapshot",
58
+ "chunkify.video.playback_error",
59
+ "chunkify.video.view_ended",
60
+ "chunkify.video.playback_state_changed",
61
+ "chunkify.video.rendition_changed",
62
+ "chunkify.video.seek_completed",
63
+ "chunkify.video.subtitle_changed",
64
+ "chunkify.video.playback_rate_changed",
65
+ ]
66
+
67
+ group_by: Union[
68
+ Literal[
69
+ "browser_name",
70
+ "os_name",
71
+ "device_type",
72
+ "continent",
73
+ "country",
74
+ "city",
75
+ "page_origin",
76
+ "page_path",
77
+ "subtitle_language",
78
+ "playback_rate",
79
+ "video_title",
80
+ "user_id",
81
+ ],
82
+ str,
83
+ ]
84
+ """A custom dimension key, such as custom.plan."""
85
+
86
+ has_fatal_error: bool
87
+
88
+ interval: Literal["hour", "day"]
89
+
90
+ kind: Literal["summary", "quality", "engagement"]
91
+
92
+ order: Literal["asc", "desc"]
93
+
94
+ os_name: str
95
+
96
+ page_origin: str
97
+ """
98
+ Exact, case-sensitive page_origin from the first retained view start, or each
99
+ event for raw-event exports.
100
+ """
101
+
102
+ page_path: str
103
+ """
104
+ Exact, case-sensitive page_path from the first retained view start, or each
105
+ event for raw-event exports.
106
+ """
107
+
108
+ playback_rate: str
109
+
110
+ sort_by: Literal[
111
+ "video_id",
112
+ "views",
113
+ "unique_viewers",
114
+ "total_playing_time_ms",
115
+ "playback_score",
116
+ "started_at",
117
+ "view_id",
118
+ "device_type",
119
+ "playing_time_ms",
120
+ "startup_time_ms",
121
+ "rebuffer_duration_ms",
122
+ ]
123
+ """Videos or views only.
124
+
125
+ Use a sort field supported by the selected resource. Defaults to video_id for
126
+ videos and started_at for views.
127
+ """
128
+
129
+ subtitle_language: str
130
+
131
+ to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
132
+
133
+ user_id: str
134
+
135
+ video_id: str
136
+
137
+ video_title: str
138
+
139
+ view_id: str
140
+
141
+ viewer_id: str
@@ -0,0 +1,11 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing_extensions import Literal
4
+
5
+ from .._models import BaseModel
6
+
7
+ __all__ = ["Health"]
8
+
9
+
10
+ class Health(BaseModel):
11
+ status: Literal["ok"]
@@ -0,0 +1,13 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from .._models import BaseModel
4
+
5
+ __all__ = ["Metrics"]
6
+
7
+
8
+ class Metrics(BaseModel):
9
+ total_playing_time_ms: float
10
+
11
+ unique_viewers: int
12
+
13
+ views: int
@@ -0,0 +1,40 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Union, Optional
4
+ from typing_extensions import Literal
5
+
6
+ from .metrics import Metrics
7
+ from .._models import BaseModel
8
+
9
+ __all__ = ["MetricsBreakdownPage", "Group"]
10
+
11
+
12
+ class Group(BaseModel):
13
+ data: Metrics
14
+
15
+ value: Optional[str] = None
16
+
17
+
18
+ class MetricsBreakdownPage(BaseModel):
19
+ group_by: Union[
20
+ Literal[
21
+ "browser_name",
22
+ "os_name",
23
+ "device_type",
24
+ "continent",
25
+ "country",
26
+ "city",
27
+ "page_origin",
28
+ "page_path",
29
+ "subtitle_language",
30
+ "playback_rate",
31
+ "video_title",
32
+ "user_id",
33
+ ],
34
+ str,
35
+ ]
36
+ """A custom dimension key, such as custom.plan."""
37
+
38
+ groups: List[Group]
39
+
40
+ next_cursor: Optional[str] = None
@@ -0,0 +1,11 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Union
4
+ from typing_extensions import TypeAlias
5
+
6
+ from .metrics import Metrics
7
+ from .metrics_breakdown_page import MetricsBreakdownPage
8
+
9
+ __all__ = ["MetricsResponse"]
10
+
11
+ MetricsResponse: TypeAlias = Union[Metrics, MetricsBreakdownPage]
@@ -0,0 +1,13 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing_extensions import Literal
4
+
5
+ from .._models import BaseModel
6
+
7
+ __all__ = ["NativeCreated"]
8
+
9
+
10
+ class NativeCreated(BaseModel):
11
+ accepted: Literal[True]
12
+
13
+ duplicate: Literal[False]
@@ -0,0 +1,13 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing_extensions import Literal
4
+
5
+ from .._models import BaseModel
6
+
7
+ __all__ = ["NativeDuplicate"]
8
+
9
+
10
+ class NativeDuplicate(BaseModel):
11
+ accepted: Literal[False]
12
+
13
+ duplicate: Literal[True]
@@ -0,0 +1,180 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Union, Optional
4
+ from datetime import datetime
5
+ from typing_extensions import Literal
6
+
7
+ from .._models import BaseModel
8
+ from .shared.played_range import PlayedRange
9
+ from .shared.browser_context import BrowserContext
10
+ from .shared.subtitle_playing_time import SubtitlePlayingTime
11
+ from .shared.rendition_playing_time import RenditionPlayingTime
12
+ from .shared.playback_rate_playing_time import PlaybackRatePlayingTime
13
+
14
+ __all__ = ["PlaybackError"]
15
+
16
+
17
+ class PlaybackError(BaseModel):
18
+ connector_name: str
19
+
20
+ connector_version: Optional[str] = None
21
+
22
+ delivery_hostname: Optional[str] = None
23
+
24
+ delivery_request_count: Optional[float] = None
25
+
26
+ delivery_throughput_bps: Optional[float] = None
27
+
28
+ delivery_transferred_bytes: Optional[float] = None
29
+
30
+ dropped_video_frames: Optional[float] = None
31
+
32
+ environment: Optional[str] = None
33
+
34
+ error_category: Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]] = None
35
+
36
+ error_code: Union[str, float, None] = None
37
+
38
+ error_fatal: Optional[bool] = None
39
+
40
+ error_playhead_seconds: Optional[float] = None
41
+
42
+ event_id: str
43
+
44
+ event_name: Literal["chunkify.video.playback_error"]
45
+
46
+ first_video_frame_time_ms: Optional[float] = None
47
+
48
+ furthest_progress_ratio: Optional[float] = None
49
+
50
+ maximum_playhead_seconds: float
51
+
52
+ media_duration_seconds: Optional[float] = None
53
+
54
+ media_height_px: Optional[float] = None
55
+
56
+ media_width_px: Optional[float] = None
57
+
58
+ occurred_at: datetime
59
+
60
+ player_height_px: Optional[float] = None
61
+
62
+ player_name: Optional[str] = None
63
+
64
+ player_version: Optional[str] = None
65
+
66
+ player_width_px: Optional[float] = None
67
+
68
+ playing_time_ms: float
69
+
70
+ reason: Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]] = None
71
+
72
+ rebuffer_count: float
73
+
74
+ rebuffer_duration_ms: float
75
+
76
+ rebuffer_ratio: Optional[float] = None
77
+
78
+ rendition_playing_time: Optional[List[RenditionPlayingTime]] = None
79
+
80
+ rendition_switch_count: Optional[float] = None
81
+
82
+ schema_version: Literal[1]
83
+
84
+ sdk_name: str
85
+ """Name of the SDK or integration that produced the event.
86
+
87
+ Informational metadata, preserved as received. Must contain at least one
88
+ non-whitespace character.
89
+ """
90
+
91
+ sdk_version: str
92
+
93
+ seek_count: float
94
+
95
+ seek_duration_ms: float
96
+
97
+ selected_rendition_bitrate_bps: Optional[float] = None
98
+
99
+ selected_rendition_codec: Optional[str] = None
100
+
101
+ selected_rendition_height: Optional[float] = None
102
+
103
+ selected_rendition_width: Optional[float] = None
104
+
105
+ sequence: int
106
+
107
+ startup_outcome: Optional[Literal["started", "failed_before_start", "ended_before_start"]] = None
108
+
109
+ startup_time_ms: Optional[float] = None
110
+
111
+ total_video_frames: Optional[float] = None
112
+
113
+ video_id: str
114
+
115
+ view_id: str
116
+
117
+ viewer_id: Optional[str] = None
118
+ """
119
+ Anonymous browser identifier generated by the Chunkify player SDK and stored in
120
+ the page's localStorage.
121
+ """
122
+
123
+ browser_context: Optional[BrowserContext] = None
124
+ """Browser and device information.
125
+
126
+ The Chunkify player sends every field, with null for unavailable measurements.
127
+ Other integrations may omit any field except schema_version. Extra properties
128
+ are preserved.
129
+ """
130
+
131
+ playback_rate: Optional[float] = None
132
+ """
133
+ Current playback rate, rounded to two decimals, such as 1, 1.5 or 2; from 0.01
134
+ to 16. Optional.
135
+ """
136
+
137
+ playback_rate_playing_time: Optional[List[PlaybackRatePlayingTime]] = None
138
+ """Cumulative playing time per playback rate for this attempt.
139
+
140
+ At most 32 entries. Optional.
141
+ """
142
+
143
+ played_ranges: Optional[List[PlayedRange]] = None
144
+ """
145
+ Cumulative played media ranges for this attempt, sorted and merged without
146
+ overlaps. Seeking, pauses and buffering are excluded. Missing or null means
147
+ unavailable; an empty array means measured but no section played. Replaying a
148
+ section does not add another range.
149
+ """
150
+
151
+ playhead_seconds: Optional[float] = None
152
+ """Current media position at this event, not the maximum reached."""
153
+
154
+ subtitle_language: Optional[str] = None
155
+ """
156
+ Language tag (BCP 47) of the showing subtitles or captions track; und when the
157
+ track declares no language; null when subtitles are off. Optional.
158
+ """
159
+
160
+ subtitle_playing_time: Optional[List[SubtitlePlayingTime]] = None
161
+ """
162
+ Cumulative playing time per subtitle language for this attempt, null language
163
+ meaning subtitles off. At most 32 entries. Optional.
164
+ """
165
+
166
+ user_id: Optional[str] = None
167
+ """
168
+ Optional integrator-supplied user ID, used to link views to the integrator's own
169
+ users.
170
+ """
171
+
172
+ video_title: Optional[str] = None
173
+ """Optional human-readable video title for reports."""
174
+
175
+ visibility_state: Optional[Literal["visible", "hidden"]] = None
176
+ """Tab visibility when the event was recorded.
177
+
178
+ Hidden does not imply paused playback or identify the cause of a pause. Missing
179
+ on older events; null when unavailable.
180
+ """
@@ -0,0 +1,182 @@
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, Iterable, Optional
6
+ from datetime import datetime
7
+ from typing_extensions import Literal, Required, Annotated, TypedDict
8
+
9
+ from .._utils import PropertyInfo
10
+ from .shared_params.played_range import PlayedRange
11
+ from .shared_params.browser_context import BrowserContext
12
+ from .shared_params.subtitle_playing_time import SubtitlePlayingTime
13
+ from .shared_params.rendition_playing_time import RenditionPlayingTime
14
+ from .shared_params.playback_rate_playing_time import PlaybackRatePlayingTime
15
+
16
+ __all__ = ["PlaybackErrorParam"]
17
+
18
+
19
+ class PlaybackErrorParam(TypedDict, total=False):
20
+ connector_name: Required[str]
21
+
22
+ connector_version: Required[Optional[str]]
23
+
24
+ delivery_hostname: Required[Optional[str]]
25
+
26
+ delivery_request_count: Required[Optional[float]]
27
+
28
+ delivery_throughput_bps: Required[Optional[float]]
29
+
30
+ delivery_transferred_bytes: Required[Optional[float]]
31
+
32
+ dropped_video_frames: Required[Optional[float]]
33
+
34
+ environment: Required[Optional[str]]
35
+
36
+ error_category: Required[Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]]]
37
+
38
+ error_code: Required[Union[str, float, None]]
39
+
40
+ error_fatal: Required[Optional[bool]]
41
+
42
+ error_playhead_seconds: Required[Optional[float]]
43
+
44
+ event_id: Required[str]
45
+
46
+ event_name: Required[Literal["chunkify.video.playback_error"]]
47
+
48
+ first_video_frame_time_ms: Required[Optional[float]]
49
+
50
+ furthest_progress_ratio: Required[Optional[float]]
51
+
52
+ maximum_playhead_seconds: Required[float]
53
+
54
+ media_duration_seconds: Required[Optional[float]]
55
+
56
+ media_height_px: Required[Optional[float]]
57
+
58
+ media_width_px: Required[Optional[float]]
59
+
60
+ occurred_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
61
+
62
+ player_height_px: Required[Optional[float]]
63
+
64
+ player_name: Required[Optional[str]]
65
+
66
+ player_version: Required[Optional[str]]
67
+
68
+ player_width_px: Required[Optional[float]]
69
+
70
+ playing_time_ms: Required[float]
71
+
72
+ reason: Required[Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]]]
73
+
74
+ rebuffer_count: Required[float]
75
+
76
+ rebuffer_duration_ms: Required[float]
77
+
78
+ rebuffer_ratio: Required[Optional[float]]
79
+
80
+ rendition_playing_time: Required[Optional[Iterable[RenditionPlayingTime]]]
81
+
82
+ rendition_switch_count: Required[Optional[float]]
83
+
84
+ schema_version: Required[Literal[1]]
85
+
86
+ sdk_name: Required[str]
87
+ """Name of the SDK or integration that produced the event.
88
+
89
+ Informational metadata, preserved as received. Must contain at least one
90
+ non-whitespace character.
91
+ """
92
+
93
+ sdk_version: Required[str]
94
+
95
+ seek_count: Required[float]
96
+
97
+ seek_duration_ms: Required[float]
98
+
99
+ selected_rendition_bitrate_bps: Required[Optional[float]]
100
+
101
+ selected_rendition_codec: Required[Optional[str]]
102
+
103
+ selected_rendition_height: Required[Optional[float]]
104
+
105
+ selected_rendition_width: Required[Optional[float]]
106
+
107
+ sequence: Required[int]
108
+
109
+ startup_outcome: Required[Optional[Literal["started", "failed_before_start", "ended_before_start"]]]
110
+
111
+ startup_time_ms: Required[Optional[float]]
112
+
113
+ total_video_frames: Required[Optional[float]]
114
+
115
+ video_id: Required[str]
116
+
117
+ view_id: Required[str]
118
+
119
+ viewer_id: Required[Optional[str]]
120
+ """
121
+ Anonymous browser identifier generated by the Chunkify player SDK and stored in
122
+ the page's localStorage.
123
+ """
124
+
125
+ browser_context: Optional[BrowserContext]
126
+ """Browser and device information.
127
+
128
+ The Chunkify player sends every field, with null for unavailable measurements.
129
+ Other integrations may omit any field except schema_version. Extra properties
130
+ are preserved.
131
+ """
132
+
133
+ playback_rate: Optional[float]
134
+ """
135
+ Current playback rate, rounded to two decimals, such as 1, 1.5 or 2; from 0.01
136
+ to 16. Optional.
137
+ """
138
+
139
+ playback_rate_playing_time: Optional[Iterable[PlaybackRatePlayingTime]]
140
+ """Cumulative playing time per playback rate for this attempt.
141
+
142
+ At most 32 entries. Optional.
143
+ """
144
+
145
+ played_ranges: Optional[Iterable[PlayedRange]]
146
+ """
147
+ Cumulative played media ranges for this attempt, sorted and merged without
148
+ overlaps. Seeking, pauses and buffering are excluded. Missing or null means
149
+ unavailable; an empty array means measured but no section played. Replaying a
150
+ section does not add another range.
151
+ """
152
+
153
+ playhead_seconds: Optional[float]
154
+ """Current media position at this event, not the maximum reached."""
155
+
156
+ subtitle_language: Optional[str]
157
+ """
158
+ Language tag (BCP 47) of the showing subtitles or captions track; und when the
159
+ track declares no language; null when subtitles are off. Optional.
160
+ """
161
+
162
+ subtitle_playing_time: Optional[Iterable[SubtitlePlayingTime]]
163
+ """
164
+ Cumulative playing time per subtitle language for this attempt, null language
165
+ meaning subtitles off. At most 32 entries. Optional.
166
+ """
167
+
168
+ user_id: Optional[str]
169
+ """
170
+ Optional integrator-supplied user ID, used to link views to the integrator's own
171
+ users.
172
+ """
173
+
174
+ video_title: Optional[str]
175
+ """Optional human-readable video title for reports."""
176
+
177
+ visibility_state: Optional[Literal["visible", "hidden"]]
178
+ """Tab visibility when the event was recorded.
179
+
180
+ Hidden does not imply paused playback or identify the cause of a pause. Missing
181
+ on older events; null when unavailable.
182
+ """