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,150 @@
|
|
|
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.browser_context import BrowserContext
|
|
9
|
+
from .shared.rendition_playing_time import RenditionPlayingTime
|
|
10
|
+
|
|
11
|
+
__all__ = ["SubtitleChanged"]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class SubtitleChanged(BaseModel):
|
|
15
|
+
connector_name: str
|
|
16
|
+
|
|
17
|
+
connector_version: Optional[str] = None
|
|
18
|
+
|
|
19
|
+
delivery_hostname: Optional[str] = None
|
|
20
|
+
|
|
21
|
+
environment: Optional[str] = None
|
|
22
|
+
|
|
23
|
+
error_category: Optional[Literal["aborted", "network", "decode", "unsupported", "unknown"]] = None
|
|
24
|
+
|
|
25
|
+
error_code: Union[str, float, None] = None
|
|
26
|
+
|
|
27
|
+
error_fatal: Optional[bool] = None
|
|
28
|
+
|
|
29
|
+
error_playhead_seconds: Optional[float] = None
|
|
30
|
+
|
|
31
|
+
event_id: str
|
|
32
|
+
|
|
33
|
+
event_name: Literal["chunkify.video.subtitle_changed"]
|
|
34
|
+
|
|
35
|
+
occurred_at: datetime
|
|
36
|
+
|
|
37
|
+
player_name: Optional[str] = None
|
|
38
|
+
|
|
39
|
+
player_version: Optional[str] = None
|
|
40
|
+
|
|
41
|
+
playhead_seconds: Optional[float] = None
|
|
42
|
+
|
|
43
|
+
previous_subtitle_language: Optional[str] = None
|
|
44
|
+
"""Language before the change; null when subtitles were off."""
|
|
45
|
+
|
|
46
|
+
reason: Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]] = None
|
|
47
|
+
|
|
48
|
+
schema_version: Literal[1]
|
|
49
|
+
|
|
50
|
+
sdk_name: str
|
|
51
|
+
"""Name of the SDK or integration that produced the event.
|
|
52
|
+
|
|
53
|
+
Informational metadata, preserved as received. Must contain at least one
|
|
54
|
+
non-whitespace character.
|
|
55
|
+
"""
|
|
56
|
+
|
|
57
|
+
sdk_version: str
|
|
58
|
+
|
|
59
|
+
sequence: int
|
|
60
|
+
|
|
61
|
+
startup_outcome: Optional[Literal["started", "failed_before_start", "ended_before_start"]] = None
|
|
62
|
+
|
|
63
|
+
subtitle_language: Optional[str] = None
|
|
64
|
+
"""Language after the change; null when subtitles are now off."""
|
|
65
|
+
|
|
66
|
+
video_id: str
|
|
67
|
+
|
|
68
|
+
view_id: str
|
|
69
|
+
|
|
70
|
+
viewer_id: Optional[str] = None
|
|
71
|
+
"""
|
|
72
|
+
Anonymous browser identifier generated by the Chunkify player SDK and stored in
|
|
73
|
+
the page's localStorage.
|
|
74
|
+
"""
|
|
75
|
+
|
|
76
|
+
browser_context: Optional[BrowserContext] = None
|
|
77
|
+
"""Browser and device information.
|
|
78
|
+
|
|
79
|
+
The Chunkify player sends every field, with null for unavailable measurements.
|
|
80
|
+
Other integrations may omit any field except schema_version. Extra properties
|
|
81
|
+
are preserved.
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
delivery_request_count: Optional[float] = None
|
|
85
|
+
|
|
86
|
+
delivery_throughput_bps: Optional[float] = None
|
|
87
|
+
|
|
88
|
+
delivery_transferred_bytes: Optional[float] = None
|
|
89
|
+
|
|
90
|
+
dropped_video_frames: Optional[float] = None
|
|
91
|
+
|
|
92
|
+
first_video_frame_time_ms: Optional[float] = None
|
|
93
|
+
|
|
94
|
+
furthest_progress_ratio: Optional[float] = None
|
|
95
|
+
|
|
96
|
+
maximum_playhead_seconds: Optional[float] = None
|
|
97
|
+
|
|
98
|
+
media_duration_seconds: Optional[float] = None
|
|
99
|
+
|
|
100
|
+
media_height_px: Optional[float] = None
|
|
101
|
+
|
|
102
|
+
media_width_px: Optional[float] = None
|
|
103
|
+
|
|
104
|
+
player_height_px: Optional[float] = None
|
|
105
|
+
|
|
106
|
+
player_width_px: Optional[float] = None
|
|
107
|
+
|
|
108
|
+
playing_time_ms: Optional[float] = None
|
|
109
|
+
|
|
110
|
+
rebuffer_count: Optional[float] = None
|
|
111
|
+
|
|
112
|
+
rebuffer_duration_ms: Optional[float] = None
|
|
113
|
+
|
|
114
|
+
rebuffer_ratio: Optional[float] = None
|
|
115
|
+
|
|
116
|
+
rendition_playing_time: Optional[List[RenditionPlayingTime]] = None
|
|
117
|
+
|
|
118
|
+
rendition_switch_count: Optional[float] = None
|
|
119
|
+
|
|
120
|
+
seek_count: Optional[float] = None
|
|
121
|
+
|
|
122
|
+
seek_duration_ms: Optional[float] = None
|
|
123
|
+
|
|
124
|
+
selected_rendition_bitrate_bps: Optional[float] = None
|
|
125
|
+
|
|
126
|
+
selected_rendition_codec: Optional[str] = None
|
|
127
|
+
|
|
128
|
+
selected_rendition_height: Optional[float] = None
|
|
129
|
+
|
|
130
|
+
selected_rendition_width: Optional[float] = None
|
|
131
|
+
|
|
132
|
+
startup_time_ms: Optional[float] = None
|
|
133
|
+
|
|
134
|
+
total_video_frames: Optional[float] = None
|
|
135
|
+
|
|
136
|
+
user_id: Optional[str] = None
|
|
137
|
+
"""
|
|
138
|
+
Optional integrator-supplied user ID, used to link views to the integrator's own
|
|
139
|
+
users.
|
|
140
|
+
"""
|
|
141
|
+
|
|
142
|
+
video_title: Optional[str] = None
|
|
143
|
+
"""Optional human-readable video title for reports."""
|
|
144
|
+
|
|
145
|
+
visibility_state: Optional[Literal["visible", "hidden"]] = None
|
|
146
|
+
"""Tab visibility when the event was recorded.
|
|
147
|
+
|
|
148
|
+
Hidden does not imply paused playback or identify the cause of a pause. Missing
|
|
149
|
+
on older events; null when unavailable.
|
|
150
|
+
"""
|
|
@@ -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, 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__ = ["SubtitleChangedParam"]
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class SubtitleChangedParam(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.subtitle_changed"]]
|
|
36
|
+
|
|
37
|
+
occurred_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
|
|
38
|
+
|
|
39
|
+
player_name: Required[Optional[str]]
|
|
40
|
+
|
|
41
|
+
player_version: Required[Optional[str]]
|
|
42
|
+
|
|
43
|
+
playhead_seconds: Required[Optional[float]]
|
|
44
|
+
|
|
45
|
+
previous_subtitle_language: Required[Optional[str]]
|
|
46
|
+
"""Language before the change; null when subtitles were off."""
|
|
47
|
+
|
|
48
|
+
reason: Required[Optional[Literal["ended", "destroyed", "source_changed", "page_exit"]]]
|
|
49
|
+
|
|
50
|
+
schema_version: Required[Literal[1]]
|
|
51
|
+
|
|
52
|
+
sdk_name: Required[str]
|
|
53
|
+
"""Name of the SDK or integration that produced the event.
|
|
54
|
+
|
|
55
|
+
Informational metadata, preserved as received. Must contain at least one
|
|
56
|
+
non-whitespace character.
|
|
57
|
+
"""
|
|
58
|
+
|
|
59
|
+
sdk_version: Required[str]
|
|
60
|
+
|
|
61
|
+
sequence: Required[int]
|
|
62
|
+
|
|
63
|
+
startup_outcome: Required[Optional[Literal["started", "failed_before_start", "ended_before_start"]]]
|
|
64
|
+
|
|
65
|
+
subtitle_language: Required[Optional[str]]
|
|
66
|
+
"""Language after the change; null when subtitles are now off."""
|
|
67
|
+
|
|
68
|
+
video_id: Required[str]
|
|
69
|
+
|
|
70
|
+
view_id: Required[str]
|
|
71
|
+
|
|
72
|
+
viewer_id: Required[Optional[str]]
|
|
73
|
+
"""
|
|
74
|
+
Anonymous browser identifier generated by the Chunkify player SDK and stored in
|
|
75
|
+
the page's localStorage.
|
|
76
|
+
"""
|
|
77
|
+
|
|
78
|
+
browser_context: Optional[BrowserContext]
|
|
79
|
+
"""Browser and device information.
|
|
80
|
+
|
|
81
|
+
The Chunkify player sends every field, with null for unavailable measurements.
|
|
82
|
+
Other integrations may omit any field except schema_version. Extra properties
|
|
83
|
+
are preserved.
|
|
84
|
+
"""
|
|
85
|
+
|
|
86
|
+
delivery_request_count: Optional[float]
|
|
87
|
+
|
|
88
|
+
delivery_throughput_bps: Optional[float]
|
|
89
|
+
|
|
90
|
+
delivery_transferred_bytes: Optional[float]
|
|
91
|
+
|
|
92
|
+
dropped_video_frames: Optional[float]
|
|
93
|
+
|
|
94
|
+
first_video_frame_time_ms: Optional[float]
|
|
95
|
+
|
|
96
|
+
furthest_progress_ratio: Optional[float]
|
|
97
|
+
|
|
98
|
+
maximum_playhead_seconds: float
|
|
99
|
+
|
|
100
|
+
media_duration_seconds: Optional[float]
|
|
101
|
+
|
|
102
|
+
media_height_px: Optional[float]
|
|
103
|
+
|
|
104
|
+
media_width_px: Optional[float]
|
|
105
|
+
|
|
106
|
+
player_height_px: Optional[float]
|
|
107
|
+
|
|
108
|
+
player_width_px: Optional[float]
|
|
109
|
+
|
|
110
|
+
playing_time_ms: float
|
|
111
|
+
|
|
112
|
+
rebuffer_count: float
|
|
113
|
+
|
|
114
|
+
rebuffer_duration_ms: float
|
|
115
|
+
|
|
116
|
+
rebuffer_ratio: Optional[float]
|
|
117
|
+
|
|
118
|
+
rendition_playing_time: Optional[Iterable[RenditionPlayingTime]]
|
|
119
|
+
|
|
120
|
+
rendition_switch_count: Optional[float]
|
|
121
|
+
|
|
122
|
+
seek_count: float
|
|
123
|
+
|
|
124
|
+
seek_duration_ms: float
|
|
125
|
+
|
|
126
|
+
selected_rendition_bitrate_bps: Optional[float]
|
|
127
|
+
|
|
128
|
+
selected_rendition_codec: Optional[str]
|
|
129
|
+
|
|
130
|
+
selected_rendition_height: Optional[float]
|
|
131
|
+
|
|
132
|
+
selected_rendition_width: Optional[float]
|
|
133
|
+
|
|
134
|
+
startup_time_ms: Optional[float]
|
|
135
|
+
|
|
136
|
+
total_video_frames: Optional[float]
|
|
137
|
+
|
|
138
|
+
user_id: Optional[str]
|
|
139
|
+
"""
|
|
140
|
+
Optional integrator-supplied user ID, used to link views to the integrator's own
|
|
141
|
+
users.
|
|
142
|
+
"""
|
|
143
|
+
|
|
144
|
+
video_title: Optional[str]
|
|
145
|
+
"""Optional human-readable video title for reports."""
|
|
146
|
+
|
|
147
|
+
visibility_state: Optional[Literal["visible", "hidden"]]
|
|
148
|
+
"""Tab visibility when the event was recorded.
|
|
149
|
+
|
|
150
|
+
Hidden does not imply paused playback or identify the cause of a pause. Missing
|
|
151
|
+
on older events; null when unavailable.
|
|
152
|
+
"""
|
|
@@ -0,0 +1,26 @@
|
|
|
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
|
+
|
|
7
|
+
__all__ = ["SubtitleMetric"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class SubtitleMetric(BaseModel):
|
|
11
|
+
"""Watch time with one subtitle language, or with subtitles off."""
|
|
12
|
+
|
|
13
|
+
language: Optional[str] = None
|
|
14
|
+
"""
|
|
15
|
+
Subtitle language tag; und for a track without a language; null for subtitles
|
|
16
|
+
off.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
playing_time_ms: float
|
|
20
|
+
"""Cumulative measured playing time in this language, summed once per attempt."""
|
|
21
|
+
|
|
22
|
+
playing_time_ratio: float
|
|
23
|
+
"""Share of all measured playing time, including rows outside the returned limit."""
|
|
24
|
+
|
|
25
|
+
views: int
|
|
26
|
+
"""Distinct attempts with positive playing time in this language."""
|
|
@@ -0,0 +1,31 @@
|
|
|
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 .subtitle_metric import SubtitleMetric
|
|
7
|
+
|
|
8
|
+
__all__ = ["SubtitleReport"]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class SubtitleReport(BaseModel):
|
|
12
|
+
languages: List[SubtitleMetric]
|
|
13
|
+
"""Most-watched first, then value ascending with null first.
|
|
14
|
+
|
|
15
|
+
Defaults to 100 rows, maximum 1000. CSV exports include all matching rows.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
sample_views: int
|
|
19
|
+
"""Attempts with positive measured playing time in this report.
|
|
20
|
+
|
|
21
|
+
Older SDKs send no measurement.
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
total_languages: int
|
|
25
|
+
"""Number of distinct values before applying the row limit."""
|
|
26
|
+
|
|
27
|
+
total_playing_time_ms: float
|
|
28
|
+
"""Total measured playing time across all matching rows."""
|
|
29
|
+
|
|
30
|
+
views: int
|
|
31
|
+
"""All attempts in the filtered start cohort."""
|
|
@@ -0,0 +1,117 @@
|
|
|
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__ = ["SubtitleRetrieveParams"]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class SubtitleRetrieveParams(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
|
+
device_type: Literal["desktop", "mobile", "tablet", "unknown"]
|
|
35
|
+
"""Exact device class. unknown matches an explicit unknown value."""
|
|
36
|
+
|
|
37
|
+
from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
|
|
38
|
+
"""Inclusive RFC3339 occurrence-time lower bound, with timezone.
|
|
39
|
+
|
|
40
|
+
Summary/video queries apply it to the selected view_started event. Must be
|
|
41
|
+
before to.
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
limit: int
|
|
45
|
+
"""Maximum rows on this page.
|
|
46
|
+
|
|
47
|
+
Events and videos always support pagination; summary, quality and engagement
|
|
48
|
+
support it only with group_by.
|
|
49
|
+
"""
|
|
50
|
+
|
|
51
|
+
os_name: str
|
|
52
|
+
"""Exact operating-system name, such as macOS. Missing values do not match."""
|
|
53
|
+
|
|
54
|
+
page_origin: str
|
|
55
|
+
"""
|
|
56
|
+
Exact, case-sensitive page origin captured by the player, such as
|
|
57
|
+
https://example.com. Metrics use the first retained view start; raw events use
|
|
58
|
+
each event context. Missing values do not match.
|
|
59
|
+
"""
|
|
60
|
+
|
|
61
|
+
page_path: str
|
|
62
|
+
"""Exact, case-sensitive page path captured by the player, such as /watch/video.
|
|
63
|
+
|
|
64
|
+
Filter by page_origin as well to distinguish identical paths on different sites.
|
|
65
|
+
Metrics use the first retained view start; raw events use each event context.
|
|
66
|
+
Missing values do not match.
|
|
67
|
+
"""
|
|
68
|
+
|
|
69
|
+
playback_rate: str
|
|
70
|
+
"""
|
|
71
|
+
Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
|
|
72
|
+
2.0 and 2 are the same rate. Metrics use the rate on the first retained view
|
|
73
|
+
start; raw events use each event's value.
|
|
74
|
+
"""
|
|
75
|
+
|
|
76
|
+
subtitle_language: str
|
|
77
|
+
"""
|
|
78
|
+
Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
|
|
79
|
+
for a subtitles track without a language. Metrics use the language showing on
|
|
80
|
+
the first retained view start; raw events use each event's value. Views without
|
|
81
|
+
subtitles at start do not match.
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
|
|
85
|
+
"""Exclusive RFC3339 occurrence-time upper bound, with timezone.
|
|
86
|
+
|
|
87
|
+
Summary/video queries apply it to the selected view_started event.
|
|
88
|
+
"""
|
|
89
|
+
|
|
90
|
+
user_id: str
|
|
91
|
+
"""Exact integrator-supplied user ID.
|
|
92
|
+
|
|
93
|
+
Selects views by their start event; event lists match each event's own value.
|
|
94
|
+
Missing/null user IDs do not match. Reports with this filter read one stored row
|
|
95
|
+
per view.
|
|
96
|
+
"""
|
|
97
|
+
|
|
98
|
+
video_id: str
|
|
99
|
+
"""Exact video ID; must not be blank. Combined with all other filters using AND."""
|
|
100
|
+
|
|
101
|
+
video_title: str
|
|
102
|
+
"""Exact, case-sensitive video title.
|
|
103
|
+
|
|
104
|
+
Selects views by the title on their first retained start; event lists match each
|
|
105
|
+
event's own value. Views without a title do not match. Reports with this filter
|
|
106
|
+
read one stored row per view.
|
|
107
|
+
"""
|
|
108
|
+
|
|
109
|
+
view_id: str
|
|
110
|
+
"""Filter one playback attempt by view ID. Metrics use its first retained start."""
|
|
111
|
+
|
|
112
|
+
viewer_id: str
|
|
113
|
+
"""Exact viewer ID.
|
|
114
|
+
|
|
115
|
+
The Chunkify player SDK generates one per browser; missing/null viewer IDs do
|
|
116
|
+
not match.
|
|
117
|
+
"""
|
|
@@ -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__ = ["SummaryRetrieveParams"]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class SummaryRetrieveParams(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,22 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from datetime import datetime
|
|
4
|
+
|
|
5
|
+
from .._models import BaseModel
|
|
6
|
+
|
|
7
|
+
__all__ = ["TimeBucket"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class TimeBucket(BaseModel):
|
|
11
|
+
bucket_start: datetime
|
|
12
|
+
"""UTC interval start in RFC3339 with milliseconds and Z.
|
|
13
|
+
|
|
14
|
+
May precede from in a partial first bucket; only starts inside [from, to)
|
|
15
|
+
contribute.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
total_playing_time_ms: float
|
|
19
|
+
|
|
20
|
+
unique_viewers: int
|
|
21
|
+
|
|
22
|
+
views: int
|
|
@@ -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 .time_bucket import TimeBucket
|
|
11
|
+
|
|
12
|
+
__all__ = ["Timeseries"]
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class Timeseries(BaseModel):
|
|
16
|
+
buckets: List[TimeBucket]
|
|
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["summary"]
|
|
24
|
+
|
|
25
|
+
timezone: Literal["UTC"]
|
|
26
|
+
|
|
27
|
+
to: datetime
|
|
28
|
+
"""Exclusive query bound normalized to UTC milliseconds."""
|