File size: 8,276 Bytes
9410704 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | # This file was auto-generated by Fern from our API Definition.
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.breakdown_types import BreakdownTypes
from ..types.metric_type import MetricType
from ..types.usage_aggregation_interval import UsageAggregationInterval
from ..types.usage_characters_response_model import UsageCharactersResponseModel
from .raw_client import AsyncRawUsageClient, RawUsageClient
class UsageClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawUsageClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawUsageClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawUsageClient
"""
return self._raw_client
def get(
self,
*,
start_unix: int,
end_unix: int,
include_workspace_metrics: typing.Optional[bool] = None,
breakdown_type: typing.Optional[BreakdownTypes] = None,
aggregation_interval: typing.Optional[UsageAggregationInterval] = None,
aggregation_bucket_size: typing.Optional[int] = None,
metric: typing.Optional[MetricType] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> UsageCharactersResponseModel:
"""
(Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead, which exposes the bucket size as `interval_seconds` (an integer in seconds) rather than `aggregation_interval`. Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
Parameters
----------
start_unix : int
UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
end_unix : int
UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
include_workspace_metrics : typing.Optional[bool]
Whether or not to include the statistics of the entire workspace.
breakdown_type : typing.Optional[BreakdownTypes]
How to break down the information. Cannot be "user" if include_workspace_metrics is False.
aggregation_interval : typing.Optional[UsageAggregationInterval]
How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
aggregation_bucket_size : typing.Optional[int]
Aggregation bucket size in seconds. Overrides the aggregation interval.
metric : typing.Optional[MetricType]
Which metric to aggregate.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
UsageCharactersResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.usage.get(
start_unix=1,
end_unix=1,
include_workspace_metrics=True,
breakdown_type="none",
aggregation_interval="hour",
aggregation_bucket_size=1,
metric="credits",
)
"""
_response = self._raw_client.get(
start_unix=start_unix,
end_unix=end_unix,
include_workspace_metrics=include_workspace_metrics,
breakdown_type=breakdown_type,
aggregation_interval=aggregation_interval,
aggregation_bucket_size=aggregation_bucket_size,
metric=metric,
request_options=request_options,
)
return _response.data
class AsyncUsageClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawUsageClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawUsageClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawUsageClient
"""
return self._raw_client
async def get(
self,
*,
start_unix: int,
end_unix: int,
include_workspace_metrics: typing.Optional[bool] = None,
breakdown_type: typing.Optional[BreakdownTypes] = None,
aggregation_interval: typing.Optional[UsageAggregationInterval] = None,
aggregation_bucket_size: typing.Optional[int] = None,
metric: typing.Optional[MetricType] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> UsageCharactersResponseModel:
"""
(Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead, which exposes the bucket size as `interval_seconds` (an integer in seconds) rather than `aggregation_interval`. Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
Parameters
----------
start_unix : int
UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
end_unix : int
UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
include_workspace_metrics : typing.Optional[bool]
Whether or not to include the statistics of the entire workspace.
breakdown_type : typing.Optional[BreakdownTypes]
How to break down the information. Cannot be "user" if include_workspace_metrics is False.
aggregation_interval : typing.Optional[UsageAggregationInterval]
How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
aggregation_bucket_size : typing.Optional[int]
Aggregation bucket size in seconds. Overrides the aggregation interval.
metric : typing.Optional[MetricType]
Which metric to aggregate.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
UsageCharactersResponseModel
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.usage.get(
start_unix=1,
end_unix=1,
include_workspace_metrics=True,
breakdown_type="none",
aggregation_interval="hour",
aggregation_bucket_size=1,
metric="credits",
)
asyncio.run(main())
"""
_response = await self._raw_client.get(
start_unix=start_unix,
end_unix=end_unix,
include_workspace_metrics=include_workspace_metrics,
breakdown_type=breakdown_type,
aggregation_interval=aggregation_interval,
aggregation_bucket_size=aggregation_bucket_size,
metric=metric,
request_options=request_options,
)
return _response.data
|