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,159 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import httpx
|
|
6
|
+
|
|
7
|
+
from .._types import Body, Query, Headers, NotGiven, not_given
|
|
8
|
+
from .._compat import cached_property
|
|
9
|
+
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
10
|
+
from .._response import (
|
|
11
|
+
to_raw_response_wrapper,
|
|
12
|
+
to_streamed_response_wrapper,
|
|
13
|
+
async_to_raw_response_wrapper,
|
|
14
|
+
async_to_streamed_response_wrapper,
|
|
15
|
+
)
|
|
16
|
+
from .._base_client import make_request_options
|
|
17
|
+
from ..types.health import Health
|
|
18
|
+
|
|
19
|
+
__all__ = ["HealthResource", "AsyncHealthResource"]
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class HealthResource(SyncAPIResource):
|
|
23
|
+
"""Health and private ingestion status."""
|
|
24
|
+
|
|
25
|
+
@cached_property
|
|
26
|
+
def with_raw_response(self) -> HealthResourceWithRawResponse:
|
|
27
|
+
"""
|
|
28
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
29
|
+
the raw response object instead of the parsed content.
|
|
30
|
+
|
|
31
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
|
|
32
|
+
"""
|
|
33
|
+
return HealthResourceWithRawResponse(self)
|
|
34
|
+
|
|
35
|
+
@cached_property
|
|
36
|
+
def with_streaming_response(self) -> HealthResourceWithStreamingResponse:
|
|
37
|
+
"""
|
|
38
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
39
|
+
|
|
40
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
|
|
41
|
+
"""
|
|
42
|
+
return HealthResourceWithStreamingResponse(self)
|
|
43
|
+
|
|
44
|
+
def retrieve(
|
|
45
|
+
self,
|
|
46
|
+
*,
|
|
47
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
48
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
49
|
+
extra_headers: Headers | None = None,
|
|
50
|
+
extra_query: Query | None = None,
|
|
51
|
+
extra_body: Body | None = None,
|
|
52
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
53
|
+
) -> Health:
|
|
54
|
+
"""Check whether the service is ready.
|
|
55
|
+
|
|
56
|
+
No API key is required.
|
|
57
|
+
|
|
58
|
+
This checks collector readiness and does not return
|
|
59
|
+
project analytics.
|
|
60
|
+
"""
|
|
61
|
+
return self._get(
|
|
62
|
+
"/healthz",
|
|
63
|
+
options=make_request_options(
|
|
64
|
+
extra_headers=extra_headers,
|
|
65
|
+
extra_query=extra_query,
|
|
66
|
+
extra_body=extra_body,
|
|
67
|
+
timeout=timeout,
|
|
68
|
+
security={},
|
|
69
|
+
),
|
|
70
|
+
cast_to=Health,
|
|
71
|
+
)
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
class AsyncHealthResource(AsyncAPIResource):
|
|
75
|
+
"""Health and private ingestion status."""
|
|
76
|
+
|
|
77
|
+
@cached_property
|
|
78
|
+
def with_raw_response(self) -> AsyncHealthResourceWithRawResponse:
|
|
79
|
+
"""
|
|
80
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
81
|
+
the raw response object instead of the parsed content.
|
|
82
|
+
|
|
83
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
|
|
84
|
+
"""
|
|
85
|
+
return AsyncHealthResourceWithRawResponse(self)
|
|
86
|
+
|
|
87
|
+
@cached_property
|
|
88
|
+
def with_streaming_response(self) -> AsyncHealthResourceWithStreamingResponse:
|
|
89
|
+
"""
|
|
90
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
91
|
+
|
|
92
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
|
|
93
|
+
"""
|
|
94
|
+
return AsyncHealthResourceWithStreamingResponse(self)
|
|
95
|
+
|
|
96
|
+
async def retrieve(
|
|
97
|
+
self,
|
|
98
|
+
*,
|
|
99
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
100
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
101
|
+
extra_headers: Headers | None = None,
|
|
102
|
+
extra_query: Query | None = None,
|
|
103
|
+
extra_body: Body | None = None,
|
|
104
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
105
|
+
) -> Health:
|
|
106
|
+
"""Check whether the service is ready.
|
|
107
|
+
|
|
108
|
+
No API key is required.
|
|
109
|
+
|
|
110
|
+
This checks collector readiness and does not return
|
|
111
|
+
project analytics.
|
|
112
|
+
"""
|
|
113
|
+
return await self._get(
|
|
114
|
+
"/healthz",
|
|
115
|
+
options=make_request_options(
|
|
116
|
+
extra_headers=extra_headers,
|
|
117
|
+
extra_query=extra_query,
|
|
118
|
+
extra_body=extra_body,
|
|
119
|
+
timeout=timeout,
|
|
120
|
+
security={},
|
|
121
|
+
),
|
|
122
|
+
cast_to=Health,
|
|
123
|
+
)
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
class HealthResourceWithRawResponse:
|
|
127
|
+
def __init__(self, health: HealthResource) -> None:
|
|
128
|
+
self._health = health
|
|
129
|
+
|
|
130
|
+
self.retrieve = to_raw_response_wrapper(
|
|
131
|
+
health.retrieve,
|
|
132
|
+
)
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
class AsyncHealthResourceWithRawResponse:
|
|
136
|
+
def __init__(self, health: AsyncHealthResource) -> None:
|
|
137
|
+
self._health = health
|
|
138
|
+
|
|
139
|
+
self.retrieve = async_to_raw_response_wrapper(
|
|
140
|
+
health.retrieve,
|
|
141
|
+
)
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
class HealthResourceWithStreamingResponse:
|
|
145
|
+
def __init__(self, health: HealthResource) -> None:
|
|
146
|
+
self._health = health
|
|
147
|
+
|
|
148
|
+
self.retrieve = to_streamed_response_wrapper(
|
|
149
|
+
health.retrieve,
|
|
150
|
+
)
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
class AsyncHealthResourceWithStreamingResponse:
|
|
154
|
+
def __init__(self, health: AsyncHealthResource) -> None:
|
|
155
|
+
self._health = health
|
|
156
|
+
|
|
157
|
+
self.retrieve = async_to_streamed_response_wrapper(
|
|
158
|
+
health.retrieve,
|
|
159
|
+
)
|
|
@@ -0,0 +1,391 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Union
|
|
6
|
+
from datetime import datetime
|
|
7
|
+
from typing_extensions import Literal
|
|
8
|
+
|
|
9
|
+
import httpx
|
|
10
|
+
|
|
11
|
+
from ..types import playback_rate_retrieve_params
|
|
12
|
+
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
13
|
+
from .._utils import maybe_transform, async_maybe_transform
|
|
14
|
+
from .._compat import cached_property
|
|
15
|
+
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
16
|
+
from .._response import (
|
|
17
|
+
to_raw_response_wrapper,
|
|
18
|
+
to_streamed_response_wrapper,
|
|
19
|
+
async_to_raw_response_wrapper,
|
|
20
|
+
async_to_streamed_response_wrapper,
|
|
21
|
+
)
|
|
22
|
+
from .._base_client import make_request_options
|
|
23
|
+
from ..types.playback_rate_report import PlaybackRateReport
|
|
24
|
+
|
|
25
|
+
__all__ = ["PlaybackRatesResource", "AsyncPlaybackRatesResource"]
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
class PlaybackRatesResource(SyncAPIResource):
|
|
29
|
+
"""Private retained-event and view-cohort queries."""
|
|
30
|
+
|
|
31
|
+
@cached_property
|
|
32
|
+
def with_raw_response(self) -> PlaybackRatesResourceWithRawResponse:
|
|
33
|
+
"""
|
|
34
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
35
|
+
the raw response object instead of the parsed content.
|
|
36
|
+
|
|
37
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
|
|
38
|
+
"""
|
|
39
|
+
return PlaybackRatesResourceWithRawResponse(self)
|
|
40
|
+
|
|
41
|
+
@cached_property
|
|
42
|
+
def with_streaming_response(self) -> PlaybackRatesResourceWithStreamingResponse:
|
|
43
|
+
"""
|
|
44
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
45
|
+
|
|
46
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
|
|
47
|
+
"""
|
|
48
|
+
return PlaybackRatesResourceWithStreamingResponse(self)
|
|
49
|
+
|
|
50
|
+
def retrieve(
|
|
51
|
+
self,
|
|
52
|
+
*,
|
|
53
|
+
browser_name: str | Omit = omit,
|
|
54
|
+
city: str | Omit = omit,
|
|
55
|
+
continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
|
|
56
|
+
country: str | Omit = omit,
|
|
57
|
+
device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
|
|
58
|
+
from_: Union[str, datetime] | Omit = omit,
|
|
59
|
+
limit: int | Omit = omit,
|
|
60
|
+
os_name: str | Omit = omit,
|
|
61
|
+
page_origin: str | Omit = omit,
|
|
62
|
+
page_path: str | Omit = omit,
|
|
63
|
+
playback_rate: str | Omit = omit,
|
|
64
|
+
subtitle_language: str | Omit = omit,
|
|
65
|
+
to: Union[str, datetime] | Omit = omit,
|
|
66
|
+
user_id: str | Omit = omit,
|
|
67
|
+
video_id: str | Omit = omit,
|
|
68
|
+
video_title: str | Omit = omit,
|
|
69
|
+
view_id: str | Omit = omit,
|
|
70
|
+
viewer_id: str | Omit = omit,
|
|
71
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
72
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
73
|
+
extra_headers: Headers | None = None,
|
|
74
|
+
extra_query: Query | None = None,
|
|
75
|
+
extra_body: Body | None = None,
|
|
76
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
77
|
+
) -> PlaybackRateReport:
|
|
78
|
+
"""Summarize watch time per playback rate.
|
|
79
|
+
|
|
80
|
+
Expand each view's cumulative
|
|
81
|
+
playback_rate_playing_time array once; rates are rounded to two decimals.
|
|
82
|
+
Playing time is wall-clock time, so a minute at 2 covers about two minutes of
|
|
83
|
+
media. Use only the selected final event, or latest snapshot when no final
|
|
84
|
+
exists, for the filtered view-start cohort. Missing or empty measurements
|
|
85
|
+
contribute no time; older SDKs send none. Rank by playing time descending, then
|
|
86
|
+
value ascending with null first; limit bounds returned rows only, while totals
|
|
87
|
+
cover every matching row. Views can contribute to several rows and must not be
|
|
88
|
+
summed. No cursor, group_by, sort_by or order. Export resource=playback_rates
|
|
89
|
+
includes all matching rows.
|
|
90
|
+
|
|
91
|
+
Args:
|
|
92
|
+
browser_name: Exact browser name, such as Chrome. Missing values do not match.
|
|
93
|
+
|
|
94
|
+
city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
|
|
95
|
+
characters. Use country alongside city to distinguish places with the same name.
|
|
96
|
+
Missing locations do not match.
|
|
97
|
+
|
|
98
|
+
continent: Exact continent code from the local lookup. Missing locations do not match.
|
|
99
|
+
|
|
100
|
+
country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
|
|
101
|
+
do not match.
|
|
102
|
+
|
|
103
|
+
device_type: Exact device class. unknown matches an explicit unknown value.
|
|
104
|
+
|
|
105
|
+
from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
|
|
106
|
+
queries apply it to the selected view_started event. Must be before to.
|
|
107
|
+
|
|
108
|
+
limit: Maximum rows on this page. Events and videos always support pagination; summary,
|
|
109
|
+
quality and engagement support it only with group_by.
|
|
110
|
+
|
|
111
|
+
os_name: Exact operating-system name, such as macOS. Missing values do not match.
|
|
112
|
+
|
|
113
|
+
page_origin: Exact, case-sensitive page origin captured by the player, such as
|
|
114
|
+
https://example.com. Metrics use the first retained view start; raw events use
|
|
115
|
+
each event context. Missing values do not match.
|
|
116
|
+
|
|
117
|
+
page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
|
|
118
|
+
Filter by page_origin as well to distinguish identical paths on different sites.
|
|
119
|
+
Metrics use the first retained view start; raw events use each event context.
|
|
120
|
+
Missing values do not match.
|
|
121
|
+
|
|
122
|
+
playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
|
|
123
|
+
2.0 and 2 are the same rate. Metrics use the rate on the first retained view
|
|
124
|
+
start; raw events use each event's value.
|
|
125
|
+
|
|
126
|
+
subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
|
|
127
|
+
for a subtitles track without a language. Metrics use the language showing on
|
|
128
|
+
the first retained view start; raw events use each event's value. Views without
|
|
129
|
+
subtitles at start do not match.
|
|
130
|
+
|
|
131
|
+
to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
|
|
132
|
+
queries apply it to the selected view_started event.
|
|
133
|
+
|
|
134
|
+
user_id: Exact integrator-supplied user ID. Selects views by their start event; event
|
|
135
|
+
lists match each event's own value. Missing/null user IDs do not match. Reports
|
|
136
|
+
with this filter read one stored row per view.
|
|
137
|
+
|
|
138
|
+
video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
|
|
139
|
+
|
|
140
|
+
video_title: Exact, case-sensitive video title. Selects views by the title on their first
|
|
141
|
+
retained start; event lists match each event's own value. Views without a title
|
|
142
|
+
do not match. Reports with this filter read one stored row per view.
|
|
143
|
+
|
|
144
|
+
view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
|
|
145
|
+
|
|
146
|
+
viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
|
|
147
|
+
viewer IDs do not match.
|
|
148
|
+
|
|
149
|
+
extra_headers: Send extra headers
|
|
150
|
+
|
|
151
|
+
extra_query: Add additional query parameters to the request
|
|
152
|
+
|
|
153
|
+
extra_body: Add additional JSON properties to the request
|
|
154
|
+
|
|
155
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
156
|
+
"""
|
|
157
|
+
return self._get(
|
|
158
|
+
"/v1/playback-rates",
|
|
159
|
+
options=make_request_options(
|
|
160
|
+
extra_headers=extra_headers,
|
|
161
|
+
extra_query=extra_query,
|
|
162
|
+
extra_body=extra_body,
|
|
163
|
+
timeout=timeout,
|
|
164
|
+
query=maybe_transform(
|
|
165
|
+
{
|
|
166
|
+
"browser_name": browser_name,
|
|
167
|
+
"city": city,
|
|
168
|
+
"continent": continent,
|
|
169
|
+
"country": country,
|
|
170
|
+
"device_type": device_type,
|
|
171
|
+
"from_": from_,
|
|
172
|
+
"limit": limit,
|
|
173
|
+
"os_name": os_name,
|
|
174
|
+
"page_origin": page_origin,
|
|
175
|
+
"page_path": page_path,
|
|
176
|
+
"playback_rate": playback_rate,
|
|
177
|
+
"subtitle_language": subtitle_language,
|
|
178
|
+
"to": to,
|
|
179
|
+
"user_id": user_id,
|
|
180
|
+
"video_id": video_id,
|
|
181
|
+
"video_title": video_title,
|
|
182
|
+
"view_id": view_id,
|
|
183
|
+
"viewer_id": viewer_id,
|
|
184
|
+
},
|
|
185
|
+
playback_rate_retrieve_params.PlaybackRateRetrieveParams,
|
|
186
|
+
),
|
|
187
|
+
security={"secret_key": True},
|
|
188
|
+
),
|
|
189
|
+
cast_to=PlaybackRateReport,
|
|
190
|
+
)
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
class AsyncPlaybackRatesResource(AsyncAPIResource):
|
|
194
|
+
"""Private retained-event and view-cohort queries."""
|
|
195
|
+
|
|
196
|
+
@cached_property
|
|
197
|
+
def with_raw_response(self) -> AsyncPlaybackRatesResourceWithRawResponse:
|
|
198
|
+
"""
|
|
199
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
200
|
+
the raw response object instead of the parsed content.
|
|
201
|
+
|
|
202
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
|
|
203
|
+
"""
|
|
204
|
+
return AsyncPlaybackRatesResourceWithRawResponse(self)
|
|
205
|
+
|
|
206
|
+
@cached_property
|
|
207
|
+
def with_streaming_response(self) -> AsyncPlaybackRatesResourceWithStreamingResponse:
|
|
208
|
+
"""
|
|
209
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
210
|
+
|
|
211
|
+
For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
|
|
212
|
+
"""
|
|
213
|
+
return AsyncPlaybackRatesResourceWithStreamingResponse(self)
|
|
214
|
+
|
|
215
|
+
async def retrieve(
|
|
216
|
+
self,
|
|
217
|
+
*,
|
|
218
|
+
browser_name: str | Omit = omit,
|
|
219
|
+
city: str | Omit = omit,
|
|
220
|
+
continent: Literal["AF", "AN", "AS", "EU", "NA", "OC", "SA"] | Omit = omit,
|
|
221
|
+
country: str | Omit = omit,
|
|
222
|
+
device_type: Literal["desktop", "mobile", "tablet", "unknown"] | Omit = omit,
|
|
223
|
+
from_: Union[str, datetime] | Omit = omit,
|
|
224
|
+
limit: int | Omit = omit,
|
|
225
|
+
os_name: str | Omit = omit,
|
|
226
|
+
page_origin: str | Omit = omit,
|
|
227
|
+
page_path: str | Omit = omit,
|
|
228
|
+
playback_rate: str | Omit = omit,
|
|
229
|
+
subtitle_language: str | Omit = omit,
|
|
230
|
+
to: Union[str, datetime] | Omit = omit,
|
|
231
|
+
user_id: str | Omit = omit,
|
|
232
|
+
video_id: str | Omit = omit,
|
|
233
|
+
video_title: str | Omit = omit,
|
|
234
|
+
view_id: str | Omit = omit,
|
|
235
|
+
viewer_id: str | Omit = omit,
|
|
236
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
237
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
238
|
+
extra_headers: Headers | None = None,
|
|
239
|
+
extra_query: Query | None = None,
|
|
240
|
+
extra_body: Body | None = None,
|
|
241
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
242
|
+
) -> PlaybackRateReport:
|
|
243
|
+
"""Summarize watch time per playback rate.
|
|
244
|
+
|
|
245
|
+
Expand each view's cumulative
|
|
246
|
+
playback_rate_playing_time array once; rates are rounded to two decimals.
|
|
247
|
+
Playing time is wall-clock time, so a minute at 2 covers about two minutes of
|
|
248
|
+
media. Use only the selected final event, or latest snapshot when no final
|
|
249
|
+
exists, for the filtered view-start cohort. Missing or empty measurements
|
|
250
|
+
contribute no time; older SDKs send none. Rank by playing time descending, then
|
|
251
|
+
value ascending with null first; limit bounds returned rows only, while totals
|
|
252
|
+
cover every matching row. Views can contribute to several rows and must not be
|
|
253
|
+
summed. No cursor, group_by, sort_by or order. Export resource=playback_rates
|
|
254
|
+
includes all matching rows.
|
|
255
|
+
|
|
256
|
+
Args:
|
|
257
|
+
browser_name: Exact browser name, such as Chrome. Missing values do not match.
|
|
258
|
+
|
|
259
|
+
city: Exact, case-sensitive city name from the local lookup, with 1 to 256 Unicode
|
|
260
|
+
characters. Use country alongside city to distinguish places with the same name.
|
|
261
|
+
Missing locations do not match.
|
|
262
|
+
|
|
263
|
+
continent: Exact continent code from the local lookup. Missing locations do not match.
|
|
264
|
+
|
|
265
|
+
country: Exact uppercase ISO 3166-1 alpha-2 country code, such as GB. Missing locations
|
|
266
|
+
do not match.
|
|
267
|
+
|
|
268
|
+
device_type: Exact device class. unknown matches an explicit unknown value.
|
|
269
|
+
|
|
270
|
+
from_: Inclusive RFC3339 occurrence-time lower bound, with timezone. Summary/video
|
|
271
|
+
queries apply it to the selected view_started event. Must be before to.
|
|
272
|
+
|
|
273
|
+
limit: Maximum rows on this page. Events and videos always support pagination; summary,
|
|
274
|
+
quality and engagement support it only with group_by.
|
|
275
|
+
|
|
276
|
+
os_name: Exact operating-system name, such as macOS. Missing values do not match.
|
|
277
|
+
|
|
278
|
+
page_origin: Exact, case-sensitive page origin captured by the player, such as
|
|
279
|
+
https://example.com. Metrics use the first retained view start; raw events use
|
|
280
|
+
each event context. Missing values do not match.
|
|
281
|
+
|
|
282
|
+
page_path: Exact, case-sensitive page path captured by the player, such as /watch/video.
|
|
283
|
+
Filter by page_origin as well to distinguish identical paths on different sites.
|
|
284
|
+
Metrics use the first retained view start; raw events use each event context.
|
|
285
|
+
Missing values do not match.
|
|
286
|
+
|
|
287
|
+
playback_rate: Playback rate from 0.01 to 16 with at most two decimals, such as 1, 1.5 or 2;
|
|
288
|
+
2.0 and 2 are the same rate. Metrics use the rate on the first retained view
|
|
289
|
+
start; raw events use each event's value.
|
|
290
|
+
|
|
291
|
+
subtitle_language: Exact, case-sensitive, non-blank subtitle language tag, such as fr or en-US; und
|
|
292
|
+
for a subtitles track without a language. Metrics use the language showing on
|
|
293
|
+
the first retained view start; raw events use each event's value. Views without
|
|
294
|
+
subtitles at start do not match.
|
|
295
|
+
|
|
296
|
+
to: Exclusive RFC3339 occurrence-time upper bound, with timezone. Summary/video
|
|
297
|
+
queries apply it to the selected view_started event.
|
|
298
|
+
|
|
299
|
+
user_id: Exact integrator-supplied user ID. Selects views by their start event; event
|
|
300
|
+
lists match each event's own value. Missing/null user IDs do not match. Reports
|
|
301
|
+
with this filter read one stored row per view.
|
|
302
|
+
|
|
303
|
+
video_id: Exact video ID; must not be blank. Combined with all other filters using AND.
|
|
304
|
+
|
|
305
|
+
video_title: Exact, case-sensitive video title. Selects views by the title on their first
|
|
306
|
+
retained start; event lists match each event's own value. Views without a title
|
|
307
|
+
do not match. Reports with this filter read one stored row per view.
|
|
308
|
+
|
|
309
|
+
view_id: Filter one playback attempt by view ID. Metrics use its first retained start.
|
|
310
|
+
|
|
311
|
+
viewer_id: Exact viewer ID. The Chunkify player SDK generates one per browser; missing/null
|
|
312
|
+
viewer IDs do not match.
|
|
313
|
+
|
|
314
|
+
extra_headers: Send extra headers
|
|
315
|
+
|
|
316
|
+
extra_query: Add additional query parameters to the request
|
|
317
|
+
|
|
318
|
+
extra_body: Add additional JSON properties to the request
|
|
319
|
+
|
|
320
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
321
|
+
"""
|
|
322
|
+
return await self._get(
|
|
323
|
+
"/v1/playback-rates",
|
|
324
|
+
options=make_request_options(
|
|
325
|
+
extra_headers=extra_headers,
|
|
326
|
+
extra_query=extra_query,
|
|
327
|
+
extra_body=extra_body,
|
|
328
|
+
timeout=timeout,
|
|
329
|
+
query=await async_maybe_transform(
|
|
330
|
+
{
|
|
331
|
+
"browser_name": browser_name,
|
|
332
|
+
"city": city,
|
|
333
|
+
"continent": continent,
|
|
334
|
+
"country": country,
|
|
335
|
+
"device_type": device_type,
|
|
336
|
+
"from_": from_,
|
|
337
|
+
"limit": limit,
|
|
338
|
+
"os_name": os_name,
|
|
339
|
+
"page_origin": page_origin,
|
|
340
|
+
"page_path": page_path,
|
|
341
|
+
"playback_rate": playback_rate,
|
|
342
|
+
"subtitle_language": subtitle_language,
|
|
343
|
+
"to": to,
|
|
344
|
+
"user_id": user_id,
|
|
345
|
+
"video_id": video_id,
|
|
346
|
+
"video_title": video_title,
|
|
347
|
+
"view_id": view_id,
|
|
348
|
+
"viewer_id": viewer_id,
|
|
349
|
+
},
|
|
350
|
+
playback_rate_retrieve_params.PlaybackRateRetrieveParams,
|
|
351
|
+
),
|
|
352
|
+
security={"secret_key": True},
|
|
353
|
+
),
|
|
354
|
+
cast_to=PlaybackRateReport,
|
|
355
|
+
)
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
class PlaybackRatesResourceWithRawResponse:
|
|
359
|
+
def __init__(self, playback_rates: PlaybackRatesResource) -> None:
|
|
360
|
+
self._playback_rates = playback_rates
|
|
361
|
+
|
|
362
|
+
self.retrieve = to_raw_response_wrapper(
|
|
363
|
+
playback_rates.retrieve,
|
|
364
|
+
)
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
class AsyncPlaybackRatesResourceWithRawResponse:
|
|
368
|
+
def __init__(self, playback_rates: AsyncPlaybackRatesResource) -> None:
|
|
369
|
+
self._playback_rates = playback_rates
|
|
370
|
+
|
|
371
|
+
self.retrieve = async_to_raw_response_wrapper(
|
|
372
|
+
playback_rates.retrieve,
|
|
373
|
+
)
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
class PlaybackRatesResourceWithStreamingResponse:
|
|
377
|
+
def __init__(self, playback_rates: PlaybackRatesResource) -> None:
|
|
378
|
+
self._playback_rates = playback_rates
|
|
379
|
+
|
|
380
|
+
self.retrieve = to_streamed_response_wrapper(
|
|
381
|
+
playback_rates.retrieve,
|
|
382
|
+
)
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
class AsyncPlaybackRatesResourceWithStreamingResponse:
|
|
386
|
+
def __init__(self, playback_rates: AsyncPlaybackRatesResource) -> None:
|
|
387
|
+
self._playback_rates = playback_rates
|
|
388
|
+
|
|
389
|
+
self.retrieve = async_to_streamed_response_wrapper(
|
|
390
|
+
playback_rates.retrieve,
|
|
391
|
+
)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from .keys import (
|
|
4
|
+
KeysResource,
|
|
5
|
+
AsyncKeysResource,
|
|
6
|
+
KeysResourceWithRawResponse,
|
|
7
|
+
AsyncKeysResourceWithRawResponse,
|
|
8
|
+
KeysResourceWithStreamingResponse,
|
|
9
|
+
AsyncKeysResourceWithStreamingResponse,
|
|
10
|
+
)
|
|
11
|
+
from .project import (
|
|
12
|
+
ProjectResource,
|
|
13
|
+
AsyncProjectResource,
|
|
14
|
+
ProjectResourceWithRawResponse,
|
|
15
|
+
AsyncProjectResourceWithRawResponse,
|
|
16
|
+
ProjectResourceWithStreamingResponse,
|
|
17
|
+
AsyncProjectResourceWithStreamingResponse,
|
|
18
|
+
)
|
|
19
|
+
|
|
20
|
+
__all__ = [
|
|
21
|
+
"KeysResource",
|
|
22
|
+
"AsyncKeysResource",
|
|
23
|
+
"KeysResourceWithRawResponse",
|
|
24
|
+
"AsyncKeysResourceWithRawResponse",
|
|
25
|
+
"KeysResourceWithStreamingResponse",
|
|
26
|
+
"AsyncKeysResourceWithStreamingResponse",
|
|
27
|
+
"ProjectResource",
|
|
28
|
+
"AsyncProjectResource",
|
|
29
|
+
"ProjectResourceWithRawResponse",
|
|
30
|
+
"AsyncProjectResourceWithRawResponse",
|
|
31
|
+
"ProjectResourceWithStreamingResponse",
|
|
32
|
+
"AsyncProjectResourceWithStreamingResponse",
|
|
33
|
+
]
|