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,156 @@
|
|
|
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.browser_context import BrowserContext
|
|
11
|
+
from .shared_params.rendition_playing_time import RenditionPlayingTime
|
|
12
|
+
|
|
13
|
+
__all__ = ["PlaybackStateChangedParam"]
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class PlaybackStateChangedParam(TypedDict, total=False):
|
|
17
|
+
connector_name: Required[str]
|
|
18
|
+
|
|
19
|
+
connector_version: Required[Optional[str]]
|
|
20
|
+
|
|
21
|
+
delivery_hostname: Required[Optional[str]]
|
|
22
|
+
|
|
23
|
+
environment: Required[Optional[str]]
|
|
24
|
+
|
|
25
|
+
error_category: Required[Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]]]
|
|
26
|
+
|
|
27
|
+
error_code: Required[Union[str, float, None]]
|
|
28
|
+
|
|
29
|
+
error_fatal: Required[Optional[bool]]
|
|
30
|
+
|
|
31
|
+
error_playhead_seconds: Required[Optional[float]]
|
|
32
|
+
|
|
33
|
+
event_id: Required[str]
|
|
34
|
+
|
|
35
|
+
event_name: Required[Literal["chunkify.video.playback_state_changed"]]
|
|
36
|
+
|
|
37
|
+
from_state: Required[
|
|
38
|
+
Literal["startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"]
|
|
39
|
+
]
|
|
40
|
+
|
|
41
|
+
occurred_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
|
|
42
|
+
|
|
43
|
+
player_name: Required[Optional[str]]
|
|
44
|
+
|
|
45
|
+
player_version: Required[Optional[str]]
|
|
46
|
+
|
|
47
|
+
playhead_seconds: Required[Optional[float]]
|
|
48
|
+
|
|
49
|
+
previous_state_duration_ms: Required[float]
|
|
50
|
+
|
|
51
|
+
reason: Required[Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]]]
|
|
52
|
+
|
|
53
|
+
schema_version: Required[Literal[1]]
|
|
54
|
+
|
|
55
|
+
sdk_name: Required[str]
|
|
56
|
+
"""Name of the SDK or integration that produced the event.
|
|
57
|
+
|
|
58
|
+
Informational metadata, preserved as received. Must contain at least one
|
|
59
|
+
non-whitespace character.
|
|
60
|
+
"""
|
|
61
|
+
|
|
62
|
+
sdk_version: Required[str]
|
|
63
|
+
|
|
64
|
+
sequence: Required[int]
|
|
65
|
+
|
|
66
|
+
startup_outcome: Required[Optional[Literal["started", "failed_before_start", "ended_before_start"]]]
|
|
67
|
+
|
|
68
|
+
to_state: Required[
|
|
69
|
+
Literal["startup", "resuming", "playing", "paused", "buffering", "seeking", "error", "ended", "stopped"]
|
|
70
|
+
]
|
|
71
|
+
|
|
72
|
+
video_id: Required[str]
|
|
73
|
+
|
|
74
|
+
view_id: Required[str]
|
|
75
|
+
|
|
76
|
+
viewer_id: Required[Optional[str]]
|
|
77
|
+
"""
|
|
78
|
+
Anonymous browser identifier generated by the Chunkify player SDK and stored in
|
|
79
|
+
the page's localStorage.
|
|
80
|
+
"""
|
|
81
|
+
|
|
82
|
+
browser_context: Optional[BrowserContext]
|
|
83
|
+
"""Browser and device information.
|
|
84
|
+
|
|
85
|
+
The Chunkify player sends every field, with null for unavailable measurements.
|
|
86
|
+
Other integrations may omit any field except schema_version. Extra properties
|
|
87
|
+
are preserved.
|
|
88
|
+
"""
|
|
89
|
+
|
|
90
|
+
delivery_request_count: Optional[float]
|
|
91
|
+
|
|
92
|
+
delivery_throughput_bps: Optional[float]
|
|
93
|
+
|
|
94
|
+
delivery_transferred_bytes: Optional[float]
|
|
95
|
+
|
|
96
|
+
dropped_video_frames: Optional[float]
|
|
97
|
+
|
|
98
|
+
first_video_frame_time_ms: Optional[float]
|
|
99
|
+
|
|
100
|
+
furthest_progress_ratio: Optional[float]
|
|
101
|
+
|
|
102
|
+
maximum_playhead_seconds: float
|
|
103
|
+
|
|
104
|
+
media_duration_seconds: Optional[float]
|
|
105
|
+
|
|
106
|
+
media_height_px: Optional[float]
|
|
107
|
+
|
|
108
|
+
media_width_px: Optional[float]
|
|
109
|
+
|
|
110
|
+
player_height_px: Optional[float]
|
|
111
|
+
|
|
112
|
+
player_width_px: Optional[float]
|
|
113
|
+
|
|
114
|
+
playing_time_ms: float
|
|
115
|
+
|
|
116
|
+
rebuffer_count: float
|
|
117
|
+
|
|
118
|
+
rebuffer_duration_ms: float
|
|
119
|
+
|
|
120
|
+
rebuffer_ratio: Optional[float]
|
|
121
|
+
|
|
122
|
+
rendition_playing_time: Optional[Iterable[RenditionPlayingTime]]
|
|
123
|
+
|
|
124
|
+
rendition_switch_count: Optional[float]
|
|
125
|
+
|
|
126
|
+
seek_count: float
|
|
127
|
+
|
|
128
|
+
seek_duration_ms: float
|
|
129
|
+
|
|
130
|
+
selected_rendition_bitrate_bps: Optional[float]
|
|
131
|
+
|
|
132
|
+
selected_rendition_codec: Optional[str]
|
|
133
|
+
|
|
134
|
+
selected_rendition_height: Optional[float]
|
|
135
|
+
|
|
136
|
+
selected_rendition_width: Optional[float]
|
|
137
|
+
|
|
138
|
+
startup_time_ms: Optional[float]
|
|
139
|
+
|
|
140
|
+
total_video_frames: Optional[float]
|
|
141
|
+
|
|
142
|
+
user_id: Optional[str]
|
|
143
|
+
"""
|
|
144
|
+
Optional integrator-supplied user ID, used to link views to the integrator's own
|
|
145
|
+
users.
|
|
146
|
+
"""
|
|
147
|
+
|
|
148
|
+
video_title: Optional[str]
|
|
149
|
+
"""Optional human-readable video title for reports."""
|
|
150
|
+
|
|
151
|
+
visibility_state: Optional[Literal["visible", "hidden"]]
|
|
152
|
+
"""Tab visibility when the event was recorded.
|
|
153
|
+
|
|
154
|
+
Hidden does not imply paused playback or identify the cause of a pause. Missing
|
|
155
|
+
on older events; null when unavailable.
|
|
156
|
+
"""
|
|
@@ -0,0 +1,21 @@
|
|
|
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 Literal, Required, TypedDict
|
|
6
|
+
|
|
7
|
+
__all__ = ["KeyCreateParams"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class KeyCreateParams(TypedDict, total=False):
|
|
11
|
+
name: Required[str]
|
|
12
|
+
"""Key display name, up to 128 UTF-8 bytes. Whitespace-only names are rejected."""
|
|
13
|
+
|
|
14
|
+
permission: Required[Literal["public", "secret"]]
|
|
15
|
+
|
|
16
|
+
read_only: bool
|
|
17
|
+
"""Only secret keys can be read-only.
|
|
18
|
+
|
|
19
|
+
False grants full project management access to secret keys; public keys only
|
|
20
|
+
ingest events.
|
|
21
|
+
"""
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from typing import List, Optional
|
|
4
|
+
from typing_extensions import Literal
|
|
5
|
+
|
|
6
|
+
from ..._models import BaseModel
|
|
7
|
+
|
|
8
|
+
__all__ = ["Project"]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class Project(BaseModel):
|
|
12
|
+
allowed_origins: List[str]
|
|
13
|
+
|
|
14
|
+
effective_allowed_origins: List[str]
|
|
15
|
+
"""Combined shared and project origins."""
|
|
16
|
+
|
|
17
|
+
effective_retention_seconds: int
|
|
18
|
+
"""Effective retention in seconds after resolving the installation default.
|
|
19
|
+
|
|
20
|
+
0 disables expiration.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
name: str
|
|
24
|
+
|
|
25
|
+
project_id: str
|
|
26
|
+
|
|
27
|
+
restart_required: Literal[False]
|
|
28
|
+
|
|
29
|
+
retention_seconds: Optional[int] = None
|
|
30
|
+
"""Retention by server receipt time, in seconds.
|
|
31
|
+
|
|
32
|
+
0 disables expiration; null inherits the installation default.
|
|
33
|
+
"""
|
|
34
|
+
|
|
35
|
+
warning: Optional[str] = None
|
|
@@ -0,0 +1,21 @@
|
|
|
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__ = ["ProjectKey"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class ProjectKey(BaseModel):
|
|
11
|
+
id: str
|
|
12
|
+
|
|
13
|
+
name: str
|
|
14
|
+
|
|
15
|
+
permission: Literal["public", "secret"]
|
|
16
|
+
|
|
17
|
+
read_only: bool
|
|
18
|
+
"""True for a private key limited to analytics reads through HTTP and MCP.
|
|
19
|
+
|
|
20
|
+
Public keys always report false. Rotation preserves this setting.
|
|
21
|
+
"""
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from typing import List
|
|
4
|
+
|
|
5
|
+
from .._models import BaseModel
|
|
6
|
+
from .project_key import ProjectKey
|
|
7
|
+
|
|
8
|
+
__all__ = ["ProjectKeys"]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class ProjectKeys(BaseModel):
|
|
12
|
+
keys: List[ProjectKey]
|
|
13
|
+
|
|
14
|
+
project_id: str
|
|
@@ -0,0 +1,25 @@
|
|
|
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 Optional
|
|
6
|
+
from typing_extensions import TypedDict
|
|
7
|
+
|
|
8
|
+
from .._types import SequenceNotStr
|
|
9
|
+
|
|
10
|
+
__all__ = ["ProjectUpdateParams"]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class ProjectUpdateParams(TypedDict, total=False):
|
|
14
|
+
allowed_origins: SequenceNotStr[str]
|
|
15
|
+
"""Additional project origins. Shared TOML origins are always included."""
|
|
16
|
+
|
|
17
|
+
name: str
|
|
18
|
+
|
|
19
|
+
retention_seconds: Optional[int]
|
|
20
|
+
"""Retention by server receipt time, in seconds.
|
|
21
|
+
|
|
22
|
+
0 disables expiration; null inherits the installation default. Omission leaves
|
|
23
|
+
the current setting unchanged. Applies to existing and new events; removed data
|
|
24
|
+
cannot be recovered.
|
|
25
|
+
"""
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from typing import Optional
|
|
4
|
+
|
|
5
|
+
from .._models import BaseModel
|
|
6
|
+
from .shared.playback_score import PlaybackScore
|
|
7
|
+
from .shared.startup_outcomes import StartupOutcomes
|
|
8
|
+
|
|
9
|
+
__all__ = ["Quality", "Buffering", "FatalErrors", "StartupTimeMs"]
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class Buffering(BaseModel):
|
|
13
|
+
"""Duration-weighted buffering.
|
|
14
|
+
|
|
15
|
+
Startup wait, pauses and seeking are excluded by the SDK. Unknown durations are not treated as zero.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
ratio: Optional[float] = None
|
|
19
|
+
"""Total rebuffer time divided by combined playing and rebuffer time.
|
|
20
|
+
|
|
21
|
+
Null without samples. Multiply by 100 for percent.
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
sample_views: int
|
|
25
|
+
"""
|
|
26
|
+
Views with playing and rebuffer durations available and positive combined
|
|
27
|
+
duration.
|
|
28
|
+
"""
|
|
29
|
+
|
|
30
|
+
total_playing_time_ms: float
|
|
31
|
+
"""Sum of playing time for eligible buffering samples only."""
|
|
32
|
+
|
|
33
|
+
total_rebuffer_duration_ms: float
|
|
34
|
+
"""Sum of rebuffer time for the same samples."""
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class FatalErrors(BaseModel):
|
|
38
|
+
"""Observed fatal errors.
|
|
39
|
+
|
|
40
|
+
Lost events can undercount this metric; absence of an error is not proof of successful playback.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
affected_views: int
|
|
44
|
+
"""
|
|
45
|
+
Distinct selected views with at least one observed matching fatal
|
|
46
|
+
playback_error, including before playback starts.
|
|
47
|
+
"""
|
|
48
|
+
|
|
49
|
+
ratio: Optional[float] = None
|
|
50
|
+
"""Affected views divided by all selected attempts; null when views is zero.
|
|
51
|
+
|
|
52
|
+
Multiply by 100 for percent.
|
|
53
|
+
"""
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
class StartupTimeMs(BaseModel):
|
|
57
|
+
"""Time from attempt to first playing, measured once per eligible view.
|
|
58
|
+
|
|
59
|
+
This is not first-frame timing.
|
|
60
|
+
"""
|
|
61
|
+
|
|
62
|
+
median: Optional[float] = None
|
|
63
|
+
"""Continuous median startup time in milliseconds, or null without samples."""
|
|
64
|
+
|
|
65
|
+
p95: Optional[float] = None
|
|
66
|
+
"""
|
|
67
|
+
Continuous 95th percentile startup time in milliseconds, or null without
|
|
68
|
+
samples.
|
|
69
|
+
"""
|
|
70
|
+
|
|
71
|
+
sample_views: int
|
|
72
|
+
"""
|
|
73
|
+
Views with a non-null startup measurement on the selected final event or latest
|
|
74
|
+
snapshot.
|
|
75
|
+
"""
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
class Quality(BaseModel):
|
|
79
|
+
"""Playback quality for the same start cohort as summary.
|
|
80
|
+
|
|
81
|
+
All rates are fractions. Counts expose measurement coverage.
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
buffering: Buffering
|
|
85
|
+
"""Duration-weighted buffering.
|
|
86
|
+
|
|
87
|
+
Startup wait, pauses and seeking are excluded by the SDK. Unknown durations are
|
|
88
|
+
not treated as zero.
|
|
89
|
+
"""
|
|
90
|
+
|
|
91
|
+
fatal_errors: FatalErrors
|
|
92
|
+
"""Observed fatal errors.
|
|
93
|
+
|
|
94
|
+
Lost events can undercount this metric; absence of an error is not proof of
|
|
95
|
+
successful playback.
|
|
96
|
+
"""
|
|
97
|
+
|
|
98
|
+
playback_score: PlaybackScore
|
|
99
|
+
|
|
100
|
+
startup_outcomes: StartupOutcomes
|
|
101
|
+
"""Mutually exclusive outcomes.
|
|
102
|
+
|
|
103
|
+
An explicit startup_outcome on the selected final event takes precedence.
|
|
104
|
+
Otherwise an available startup time, including zero, or positive playing time on
|
|
105
|
+
the selected measurement proves started. All other views are unknown.
|
|
106
|
+
sample_views excludes unknown; every ratio uses all selected attempts, including
|
|
107
|
+
unknown. Missing final delivery does not prove an exit or failure.
|
|
108
|
+
"""
|
|
109
|
+
|
|
110
|
+
startup_time_ms: StartupTimeMs
|
|
111
|
+
"""Time from attempt to first playing, measured once per eligible view.
|
|
112
|
+
|
|
113
|
+
This is not first-frame timing.
|
|
114
|
+
"""
|
|
115
|
+
|
|
116
|
+
views: int
|
|
117
|
+
"""Selected playback attempts with a retained start, including failed attempts."""
|
|
@@ -0,0 +1,44 @@
|
|
|
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 .quality import Quality
|
|
7
|
+
from .._models import BaseModel
|
|
8
|
+
|
|
9
|
+
__all__ = ["QualityBreakdownPage", "Group"]
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class Group(BaseModel):
|
|
13
|
+
data: Quality
|
|
14
|
+
"""Playback quality for the same start cohort as summary.
|
|
15
|
+
|
|
16
|
+
All rates are fractions. Counts expose measurement coverage.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
value: Optional[str] = None
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class QualityBreakdownPage(BaseModel):
|
|
23
|
+
group_by: Union[
|
|
24
|
+
Literal[
|
|
25
|
+
"browser_name",
|
|
26
|
+
"os_name",
|
|
27
|
+
"device_type",
|
|
28
|
+
"continent",
|
|
29
|
+
"country",
|
|
30
|
+
"city",
|
|
31
|
+
"page_origin",
|
|
32
|
+
"page_path",
|
|
33
|
+
"subtitle_language",
|
|
34
|
+
"playback_rate",
|
|
35
|
+
"video_title",
|
|
36
|
+
"user_id",
|
|
37
|
+
],
|
|
38
|
+
str,
|
|
39
|
+
]
|
|
40
|
+
"""A custom dimension key, such as custom.plan."""
|
|
41
|
+
|
|
42
|
+
groups: List[Group]
|
|
43
|
+
|
|
44
|
+
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 .quality import Quality
|
|
7
|
+
from .quality_breakdown_page import QualityBreakdownPage
|
|
8
|
+
|
|
9
|
+
__all__ = ["QualityResponse"]
|
|
10
|
+
|
|
11
|
+
QualityResponse: TypeAlias = Union[Quality, QualityBreakdownPage]
|
|
@@ -0,0 +1,158 @@
|
|
|
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__ = ["QualityRetrieveParams"]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class QualityRetrieveParams(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
|
+
group_by: Union[
|
|
52
|
+
Literal[
|
|
53
|
+
"browser_name",
|
|
54
|
+
"os_name",
|
|
55
|
+
"device_type",
|
|
56
|
+
"continent",
|
|
57
|
+
"country",
|
|
58
|
+
"city",
|
|
59
|
+
"page_origin",
|
|
60
|
+
"page_path",
|
|
61
|
+
"subtitle_language",
|
|
62
|
+
"playback_rate",
|
|
63
|
+
"video_title",
|
|
64
|
+
"user_id",
|
|
65
|
+
],
|
|
66
|
+
str,
|
|
67
|
+
]
|
|
68
|
+
"""Optional on summary, quality and engagement.
|
|
69
|
+
|
|
70
|
+
Group views by this field on their first retained start. Missing, null and
|
|
71
|
+
nonstring context forms a null group; the literal device type unknown stays
|
|
72
|
+
separate. Groups sort by views descending, then value ascending with null first
|
|
73
|
+
for ties. Pagination is available only with group_by. Location uses the first
|
|
74
|
+
retained start too. City groups use the stored name; filter by country to avoid
|
|
75
|
+
combining names shared by different countries. Page groups use the first
|
|
76
|
+
retained start even if playback continues after navigation. Filter by
|
|
77
|
+
page_origin when grouping page_path to distinguish identical paths on different
|
|
78
|
+
sites. video_title groups by the title on each view's first retained start, so a
|
|
79
|
+
renamed video counts each view under the title it started with. user_id groups
|
|
80
|
+
by the user ID on each view's first retained start. Use custom.<key>, such as
|
|
81
|
+
custom.plan, to group by a custom dimension; views without the key form the null
|
|
82
|
+
group.
|
|
83
|
+
"""
|
|
84
|
+
|
|
85
|
+
limit: int
|
|
86
|
+
"""Maximum rows on this page.
|
|
87
|
+
|
|
88
|
+
Events and videos always support pagination; summary, quality and engagement
|
|
89
|
+
support it only with group_by.
|
|
90
|
+
"""
|
|
91
|
+
|
|
92
|
+
os_name: str
|
|
93
|
+
"""Exact operating-system name, such as macOS. Missing values do not match."""
|
|
94
|
+
|
|
95
|
+
page_origin: str
|
|
96
|
+
"""
|
|
97
|
+
Exact, case-sensitive page origin captured by the player, such as
|
|
98
|
+
https://example.com. Metrics use the first retained view start; raw events use
|
|
99
|
+
each event context. Missing values do not match.
|
|
100
|
+
"""
|
|
101
|
+
|
|
102
|
+
page_path: str
|
|
103
|
+
"""Exact, case-sensitive page path captured by the player, such as /watch/video.
|
|
104
|
+
|
|
105
|
+
Filter by page_origin as well to distinguish identical paths on different sites.
|
|
106
|
+
Metrics use the first retained view start; raw events use each event context.
|
|
107
|
+
Missing values do not match.
|
|
108
|
+
"""
|
|
109
|
+
|
|
110
|
+
playback_rate: str
|
|
111
|
+
"""
|
|
112
|
+
Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
|
|
113
|
+
2.0 and 2 are the same rate. Metrics use the rate on the first retained view
|
|
114
|
+
start; raw events use each event's value.
|
|
115
|
+
"""
|
|
116
|
+
|
|
117
|
+
subtitle_language: str
|
|
118
|
+
"""
|
|
119
|
+
Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
|
|
120
|
+
for a subtitles track without a language. Metrics use the language showing on
|
|
121
|
+
the first retained view start; raw events use each event's value. Views without
|
|
122
|
+
subtitles at start do not match.
|
|
123
|
+
"""
|
|
124
|
+
|
|
125
|
+
to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
|
|
126
|
+
"""Exclusive RFC3339 occurrence-time upper bound, with timezone.
|
|
127
|
+
|
|
128
|
+
Summary/video queries apply it to the selected view_started event.
|
|
129
|
+
"""
|
|
130
|
+
|
|
131
|
+
user_id: str
|
|
132
|
+
"""Exact integrator-supplied user ID.
|
|
133
|
+
|
|
134
|
+
Selects views by their start event; event lists match each event's own value.
|
|
135
|
+
Missing/null user IDs do not match. Reports with this filter read one stored row
|
|
136
|
+
per view.
|
|
137
|
+
"""
|
|
138
|
+
|
|
139
|
+
video_id: str
|
|
140
|
+
"""Exact video ID; must not be blank. Combined with all other filters using AND."""
|
|
141
|
+
|
|
142
|
+
video_title: str
|
|
143
|
+
"""Exact, case-sensitive video title.
|
|
144
|
+
|
|
145
|
+
Selects views by the title on their first retained start; event lists match each
|
|
146
|
+
event's own value. Views without a title do not match. Reports with this filter
|
|
147
|
+
read one stored row per view.
|
|
148
|
+
"""
|
|
149
|
+
|
|
150
|
+
view_id: str
|
|
151
|
+
"""Filter one playback attempt by view ID. Metrics use its first retained start."""
|
|
152
|
+
|
|
153
|
+
viewer_id: str
|
|
154
|
+
"""Exact viewer ID.
|
|
155
|
+
|
|
156
|
+
The Chunkify player SDK generates one per browser; missing/null viewer IDs do
|
|
157
|
+
not match.
|
|
158
|
+
"""
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from typing import List
|
|
4
|
+
from datetime import datetime
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
from pydantic import Field as FieldInfo
|
|
8
|
+
|
|
9
|
+
from .._models import BaseModel
|
|
10
|
+
from .quality_timeseries_bucket import QualityTimeseriesBucket
|
|
11
|
+
|
|
12
|
+
__all__ = ["QualityTimeseries"]
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class QualityTimeseries(BaseModel):
|
|
16
|
+
buckets: List[QualityTimeseriesBucket]
|
|
17
|
+
|
|
18
|
+
from_: datetime = FieldInfo(alias="from")
|
|
19
|
+
"""Inclusive query bound normalized to UTC milliseconds."""
|
|
20
|
+
|
|
21
|
+
interval: Literal["hour", "day"]
|
|
22
|
+
|
|
23
|
+
kind: Literal["quality"]
|
|
24
|
+
|
|
25
|
+
timezone: Literal["UTC"]
|
|
26
|
+
|
|
27
|
+
to: datetime
|
|
28
|
+
"""Exclusive query bound normalized to UTC milliseconds."""
|