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.
- chunkify_analytics/__init__.py +102 -0
- chunkify_analytics/_base_client.py +2153 -0
- chunkify_analytics/_client.py +1262 -0
- chunkify_analytics/_compat.py +226 -0
- chunkify_analytics/_constants.py +14 -0
- chunkify_analytics/_exceptions.py +108 -0
- chunkify_analytics/_files.py +173 -0
- chunkify_analytics/_models.py +964 -0
- chunkify_analytics/_qs.py +149 -0
- chunkify_analytics/_resource.py +43 -0
- chunkify_analytics/_response.py +835 -0
- chunkify_analytics/_streaming.py +338 -0
- chunkify_analytics/_types.py +274 -0
- chunkify_analytics/_utils/__init__.py +64 -0
- chunkify_analytics/_utils/_compat.py +45 -0
- chunkify_analytics/_utils/_datetime_parse.py +136 -0
- chunkify_analytics/_utils/_json.py +35 -0
- chunkify_analytics/_utils/_logs.py +25 -0
- chunkify_analytics/_utils/_path.py +127 -0
- chunkify_analytics/_utils/_proxy.py +65 -0
- chunkify_analytics/_utils/_reflection.py +42 -0
- chunkify_analytics/_utils/_resources_proxy.py +24 -0
- chunkify_analytics/_utils/_streams.py +12 -0
- chunkify_analytics/_utils/_sync.py +58 -0
- chunkify_analytics/_utils/_transform.py +457 -0
- chunkify_analytics/_utils/_typing.py +156 -0
- chunkify_analytics/_utils/_utils.py +433 -0
- chunkify_analytics/_version.py +4 -0
- chunkify_analytics/lib/.keep +4 -0
- chunkify_analytics/pagination.py +221 -0
- chunkify_analytics/py.typed +0 -0
- chunkify_analytics/resources/__init__.py +243 -0
- chunkify_analytics/resources/admin/__init__.py +33 -0
- chunkify_analytics/resources/admin/admin.py +253 -0
- chunkify_analytics/resources/admin/keys.py +283 -0
- chunkify_analytics/resources/dimensions.py +436 -0
- chunkify_analytics/resources/engagement.py +479 -0
- chunkify_analytics/resources/errors.py +400 -0
- chunkify_analytics/resources/events.py +562 -0
- chunkify_analytics/resources/exports.py +584 -0
- chunkify_analytics/resources/health.py +159 -0
- chunkify_analytics/resources/playback_rates.py +391 -0
- chunkify_analytics/resources/project/__init__.py +33 -0
- chunkify_analytics/resources/project/keys.py +379 -0
- chunkify_analytics/resources/project/project.py +322 -0
- chunkify_analytics/resources/quality.py +471 -0
- chunkify_analytics/resources/renditions.py +391 -0
- chunkify_analytics/resources/retention.py +377 -0
- chunkify_analytics/resources/subtitles.py +389 -0
- chunkify_analytics/resources/summary.py +469 -0
- chunkify_analytics/resources/timeseries.py +399 -0
- chunkify_analytics/resources/videos.py +424 -0
- chunkify_analytics/resources/views.py +579 -0
- chunkify_analytics/types/__init__.py +145 -0
- chunkify_analytics/types/admin/__init__.py +3 -0
- chunkify_analytics/types/admin_create_project_params.py +25 -0
- chunkify_analytics/types/analytics_event.py +32 -0
- chunkify_analytics/types/analytics_event_param.py +30 -0
- chunkify_analytics/types/created_project.py +37 -0
- chunkify_analytics/types/created_project_key.py +34 -0
- chunkify_analytics/types/deleted_project.py +18 -0
- chunkify_analytics/types/dimension_list_values_params.py +124 -0
- chunkify_analytics/types/dimension_values.py +42 -0
- chunkify_analytics/types/engagement.py +60 -0
- chunkify_analytics/types/engagement_breakdown_page.py +44 -0
- chunkify_analytics/types/engagement_response.py +11 -0
- chunkify_analytics/types/engagement_retrieve_params.py +158 -0
- chunkify_analytics/types/engagement_timeseries.py +28 -0
- chunkify_analytics/types/engagement_timeseries_bucket.py +63 -0
- chunkify_analytics/types/error_group.py +17 -0
- chunkify_analytics/types/error_list_params.py +124 -0
- chunkify_analytics/types/error_page.py +14 -0
- chunkify_analytics/types/event_ingest_params.py +19 -0
- chunkify_analytics/types/event_ingest_response.py +11 -0
- chunkify_analytics/types/event_list_params.py +146 -0
- chunkify_analytics/types/event_page.py +18 -0
- chunkify_analytics/types/export.py +18 -0
- chunkify_analytics/types/export_columns.py +12 -0
- chunkify_analytics/types/export_create_params.py +40 -0
- chunkify_analytics/types/export_download_response.py +7 -0
- chunkify_analytics/types/export_list_columns_params.py +69 -0
- chunkify_analytics/types/export_query_param.py +141 -0
- chunkify_analytics/types/health.py +11 -0
- chunkify_analytics/types/metrics.py +13 -0
- chunkify_analytics/types/metrics_breakdown_page.py +40 -0
- chunkify_analytics/types/metrics_response.py +11 -0
- chunkify_analytics/types/native_created.py +13 -0
- chunkify_analytics/types/native_duplicate.py +13 -0
- chunkify_analytics/types/playback_error.py +180 -0
- chunkify_analytics/types/playback_error_param.py +182 -0
- chunkify_analytics/types/playback_rate_changed.py +150 -0
- chunkify_analytics/types/playback_rate_changed_param.py +152 -0
- chunkify_analytics/types/playback_rate_metric.py +21 -0
- chunkify_analytics/types/playback_rate_report.py +31 -0
- chunkify_analytics/types/playback_rate_retrieve_params.py +117 -0
- chunkify_analytics/types/playback_state_changed.py +150 -0
- chunkify_analytics/types/playback_state_changed_param.py +156 -0
- chunkify_analytics/types/project/__init__.py +6 -0
- chunkify_analytics/types/project/key_create_params.py +21 -0
- chunkify_analytics/types/project/project.py +35 -0
- chunkify_analytics/types/project_key.py +21 -0
- chunkify_analytics/types/project_keys.py +14 -0
- chunkify_analytics/types/project_update_params.py +25 -0
- chunkify_analytics/types/quality.py +117 -0
- chunkify_analytics/types/quality_breakdown_page.py +44 -0
- chunkify_analytics/types/quality_response.py +11 -0
- chunkify_analytics/types/quality_retrieve_params.py +158 -0
- chunkify_analytics/types/quality_timeseries.py +28 -0
- chunkify_analytics/types/quality_timeseries_bucket.py +120 -0
- chunkify_analytics/types/rendition_changed.py +156 -0
- chunkify_analytics/types/rendition_changed_param.py +158 -0
- chunkify_analytics/types/rendition_metric.py +40 -0
- chunkify_analytics/types/rendition_report.py +43 -0
- chunkify_analytics/types/rendition_retrieve_params.py +117 -0
- chunkify_analytics/types/retention_bucket.py +22 -0
- chunkify_analytics/types/retention_report.py +33 -0
- chunkify_analytics/types/retention_retrieve_params.py +110 -0
- chunkify_analytics/types/rotated_project_key.py +29 -0
- chunkify_analytics/types/seek_completed.py +166 -0
- chunkify_analytics/types/seek_completed_param.py +168 -0
- chunkify_analytics/types/shared/__init__.py +24 -0
- chunkify_analytics/types/shared/browser_context.py +62 -0
- chunkify_analytics/types/shared/custom_dimensions.py +8 -0
- chunkify_analytics/types/shared/event_context.py +161 -0
- chunkify_analytics/types/shared/event_envelope.py +152 -0
- chunkify_analytics/types/shared/metric_count_ratio.py +18 -0
- chunkify_analytics/types/shared/otlp_any_value.py +56 -0
- chunkify_analytics/types/shared/otlp_attribute.py +24 -0
- chunkify_analytics/types/shared/otlp_attribute_value.py +136 -0
- chunkify_analytics/types/shared/otlp_context_attribute.py +22 -0
- chunkify_analytics/types/shared/otlp_log_record.py +48 -0
- chunkify_analytics/types/shared/otlp_resource.py +20 -0
- chunkify_analytics/types/shared/otlp_scope.py +24 -0
- chunkify_analytics/types/shared/playback_rate_playing_time.py +12 -0
- chunkify_analytics/types/shared/playback_score.py +28 -0
- chunkify_analytics/types/shared/played_range.py +13 -0
- chunkify_analytics/types/shared/progress_reached.py +39 -0
- chunkify_analytics/types/shared/rendition_playing_time.py +21 -0
- chunkify_analytics/types/shared/startup_outcomes.py +39 -0
- chunkify_analytics/types/shared/stored_otlp_context.py +50 -0
- chunkify_analytics/types/shared/subtitle_playing_time.py +14 -0
- chunkify_analytics/types/shared/view_metrics.py +100 -0
- chunkify_analytics/types/shared/watch_time_distribution.py +41 -0
- chunkify_analytics/types/shared_params/__init__.py +8 -0
- chunkify_analytics/types/shared_params/browser_context.py +62 -0
- chunkify_analytics/types/shared_params/custom_dimensions.py +10 -0
- chunkify_analytics/types/shared_params/playback_rate_playing_time.py +14 -0
- chunkify_analytics/types/shared_params/played_range.py +15 -0
- chunkify_analytics/types/shared_params/rendition_playing_time.py +22 -0
- chunkify_analytics/types/shared_params/subtitle_playing_time.py +15 -0
- chunkify_analytics/types/stored_event.py +44 -0
- chunkify_analytics/types/subtitle_changed.py +150 -0
- chunkify_analytics/types/subtitle_changed_param.py +152 -0
- chunkify_analytics/types/subtitle_metric.py +26 -0
- chunkify_analytics/types/subtitle_report.py +31 -0
- chunkify_analytics/types/subtitle_retrieve_params.py +117 -0
- chunkify_analytics/types/summary_retrieve_params.py +158 -0
- chunkify_analytics/types/time_bucket.py +22 -0
- chunkify_analytics/types/timeseries.py +28 -0
- chunkify_analytics/types/timeseries_response.py +12 -0
- chunkify_analytics/types/timesery_retrieve_params.py +115 -0
- chunkify_analytics/types/video_list_params.py +140 -0
- chunkify_analytics/types/video_metrics.py +23 -0
- chunkify_analytics/types/video_page.py +14 -0
- chunkify_analytics/types/view.py +43 -0
- chunkify_analytics/types/view_detail.py +21 -0
- chunkify_analytics/types/view_ended.py +180 -0
- chunkify_analytics/types/view_ended_param.py +182 -0
- chunkify_analytics/types/view_list_params.py +152 -0
- chunkify_analytics/types/view_page.py +14 -0
- chunkify_analytics/types/view_retrieve_params.py +23 -0
- chunkify_analytics/types/view_snapshot.py +180 -0
- chunkify_analytics/types/view_snapshot_param.py +182 -0
- chunkify_analytics/types/view_started.py +192 -0
- chunkify_analytics/types/view_started_param.py +194 -0
- chunkify_analytics_sdk-0.9.0.dist-info/METADATA +487 -0
- chunkify_analytics_sdk-0.9.0.dist-info/RECORD +179 -0
- chunkify_analytics_sdk-0.9.0.dist-info/WHEEL +4 -0
- chunkify_analytics_sdk-0.9.0.dist-info/licenses/LICENSE +201 -0
|
@@ -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__ = ["ViewEndedParam"]
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class ViewEndedParam(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.view_ended"]]
|
|
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
|
+
"""
|
|
@@ -0,0 +1,152 @@
|
|
|
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__ = ["ViewListParams"]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class ViewListParams(TypedDict, total=False):
|
|
15
|
+
browser_name: str
|
|
16
|
+
"""Exact browser name, such as Chrome. Missing values do not match."""
|
|
17
|
+
|
|
18
|
+
city: str
|
|
19
|
+
"""
|
|
20
|
+
Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
|
|
21
|
+
characters. Use country alongside city to distinguish places with the same name.
|
|
22
|
+
Missing locations do not match.
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"]
|
|
26
|
+
"""Exact continent code from the local lookup. Missing locations do not match."""
|
|
27
|
+
|
|
28
|
+
country: str
|
|
29
|
+
"""Exact uppercase ISO 3166-1 alpha-2 country code, such as GB.
|
|
30
|
+
|
|
31
|
+
Missing locations do not match.
|
|
32
|
+
"""
|
|
33
|
+
|
|
34
|
+
cursor: str
|
|
35
|
+
"""Use next_cursor from the previous page.
|
|
36
|
+
|
|
37
|
+
Keep the same filters, sort_by and order. Video cursors from earlier versions
|
|
38
|
+
are invalid; start a new pagination sequence after upgrading.
|
|
39
|
+
"""
|
|
40
|
+
|
|
41
|
+
device_type: Literal["desktop", "mobile", "tablet", "unknown"]
|
|
42
|
+
"""Exact device class. unknown matches an explicit unknown value."""
|
|
43
|
+
|
|
44
|
+
from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
|
|
45
|
+
"""Inclusive RFC3339 occurrence-time lower bound, with timezone.
|
|
46
|
+
|
|
47
|
+
Summary/video queries apply it to the selected view_started event. Must be
|
|
48
|
+
before to.
|
|
49
|
+
"""
|
|
50
|
+
|
|
51
|
+
has_fatal_error: bool
|
|
52
|
+
"""Select attempts with or without an observed fatal error.
|
|
53
|
+
|
|
54
|
+
Absence of an observed error does not prove successful playback.
|
|
55
|
+
"""
|
|
56
|
+
|
|
57
|
+
limit: int
|
|
58
|
+
"""Maximum rows on this page.
|
|
59
|
+
|
|
60
|
+
Events and videos always support pagination; summary, quality and engagement
|
|
61
|
+
support it only with group_by.
|
|
62
|
+
"""
|
|
63
|
+
|
|
64
|
+
order: Literal["asc", "desc"]
|
|
65
|
+
"""Sort by started_at and then view_id in this direction.
|
|
66
|
+
|
|
67
|
+
Defaults to newest first. Keep the same order with each cursor.
|
|
68
|
+
"""
|
|
69
|
+
|
|
70
|
+
os_name: str
|
|
71
|
+
"""Exact operating-system name, such as macOS. Missing values do not match."""
|
|
72
|
+
|
|
73
|
+
page_origin: str
|
|
74
|
+
"""
|
|
75
|
+
Exact, case-sensitive page origin captured by the player, such as
|
|
76
|
+
https://example.com. Metrics use the first retained view start; raw events use
|
|
77
|
+
each event context. Missing values do not match.
|
|
78
|
+
"""
|
|
79
|
+
|
|
80
|
+
page_path: str
|
|
81
|
+
"""Exact, case-sensitive page path captured by the player, such as /watch/video.
|
|
82
|
+
|
|
83
|
+
Filter by page_origin as well to distinguish identical paths on different sites.
|
|
84
|
+
Metrics use the first retained view start; raw events use each event context.
|
|
85
|
+
Missing values do not match.
|
|
86
|
+
"""
|
|
87
|
+
|
|
88
|
+
playback_rate: str
|
|
89
|
+
"""
|
|
90
|
+
Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
|
|
91
|
+
2.0 and 2 are the same rate. Metrics use the rate on the first retained view
|
|
92
|
+
start; raw events use each event's value.
|
|
93
|
+
"""
|
|
94
|
+
|
|
95
|
+
sort_by: Literal[
|
|
96
|
+
"started_at",
|
|
97
|
+
"video_id",
|
|
98
|
+
"view_id",
|
|
99
|
+
"device_type",
|
|
100
|
+
"playing_time_ms",
|
|
101
|
+
"startup_time_ms",
|
|
102
|
+
"rebuffer_duration_ms",
|
|
103
|
+
"playback_score",
|
|
104
|
+
]
|
|
105
|
+
"""Sort all matching sessions before pagination.
|
|
106
|
+
|
|
107
|
+
Missing values come last in both directions. Ties use view_id in the requested
|
|
108
|
+
direction. Keep sort_by, order and filters unchanged with a cursor.
|
|
109
|
+
"""
|
|
110
|
+
|
|
111
|
+
subtitle_language: str
|
|
112
|
+
"""
|
|
113
|
+
Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
|
|
114
|
+
for a subtitles track without a language. Metrics use the language showing on
|
|
115
|
+
the first retained view start; raw events use each event's value. Views without
|
|
116
|
+
subtitles at start do not match.
|
|
117
|
+
"""
|
|
118
|
+
|
|
119
|
+
to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
|
|
120
|
+
"""Exclusive RFC3339 occurrence-time upper bound, with timezone.
|
|
121
|
+
|
|
122
|
+
Summary/video queries apply it to the selected view_started event.
|
|
123
|
+
"""
|
|
124
|
+
|
|
125
|
+
user_id: str
|
|
126
|
+
"""Exact integrator-supplied user ID.
|
|
127
|
+
|
|
128
|
+
Selects views by their start event; event lists match each event's own value.
|
|
129
|
+
Missing/null user IDs do not match. Reports with this filter read one stored row
|
|
130
|
+
per view.
|
|
131
|
+
"""
|
|
132
|
+
|
|
133
|
+
video_id: str
|
|
134
|
+
"""Exact video ID; must not be blank. Combined with all other filters using AND."""
|
|
135
|
+
|
|
136
|
+
video_title: str
|
|
137
|
+
"""Exact, case-sensitive video title.
|
|
138
|
+
|
|
139
|
+
Selects views by the title on their first retained start; event lists match each
|
|
140
|
+
event's own value. Views without a title do not match. Reports with this filter
|
|
141
|
+
read one stored row per view.
|
|
142
|
+
"""
|
|
143
|
+
|
|
144
|
+
view_id: str
|
|
145
|
+
"""Filter one playback attempt by view ID. Metrics use its first retained start."""
|
|
146
|
+
|
|
147
|
+
viewer_id: str
|
|
148
|
+
"""Exact viewer ID.
|
|
149
|
+
|
|
150
|
+
The Chunkify player SDK generates one per browser; missing/null viewer IDs do
|
|
151
|
+
not match.
|
|
152
|
+
"""
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from typing import List, Optional
|
|
4
|
+
|
|
5
|
+
from .view import View
|
|
6
|
+
from .._models import BaseModel
|
|
7
|
+
|
|
8
|
+
__all__ = ["ViewPage"]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class ViewPage(BaseModel):
|
|
12
|
+
next_cursor: Optional[str] = None
|
|
13
|
+
|
|
14
|
+
views: List[View]
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing_extensions import TypedDict
|
|
6
|
+
|
|
7
|
+
__all__ = ["ViewRetrieveParams"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class ViewRetrieveParams(TypedDict, total=False):
|
|
11
|
+
cursor: str
|
|
12
|
+
"""Use next_cursor from the previous page.
|
|
13
|
+
|
|
14
|
+
Keep the same filters, sort_by and order. Video cursors from earlier versions
|
|
15
|
+
are invalid; start a new pagination sequence after upgrading.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
limit: int
|
|
19
|
+
"""Maximum rows on this page.
|
|
20
|
+
|
|
21
|
+
Events and videos always support pagination; summary, quality and engagement
|
|
22
|
+
support it only with group_by.
|
|
23
|
+
"""
|
|
@@ -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__ = ["ViewSnapshot"]
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class ViewSnapshot(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.view_snapshot"]
|
|
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
|
+
"""
|