> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# 获取字符用量指标

GET https://api.elevenlabs.io/v1/usage/character-stats

（已弃用）此端点已弃用。请改用 /v1/workspace/analytics/query/usage-by-product-over-time，该端点将分桶大小公开为 `interval_seconds`（以秒为单位的整数），而非 `aggregation_interval`。返回当前用户或其所属整个工作区的使用指标。响应会根据指定的聚合间隔（默认：天）提供时间轴，以及该时间轴上每个间隔的使用量。使用量会按所选细分类型拆分。例如，细分类型 "voice" 将返回时间轴上每个间隔内各音色的使用量。

Reference: https://elevenlabs.io/docs/api-reference/legacy/usage/get

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Query parameters

- `start_unix` (integer, required) — 使用时间范围开始时间的 UTC Unix 时间戳（毫秒）。若要包含范围内第一天，时间戳应设为该日的 00:00:00。
- `end_unix` (integer, required) — 使用时间范围结束时间的 UTC Unix 时间戳（毫秒）。若要包含范围内最后一天，时间戳应设为该日的 23:59:59。
- `include_workspace_metrics` (boolean, optional, default: false) — 是否包含整个工作区的统计数据。
- `breakdown_type` (enum, optional) — 如何细分信息。当 include_workspace_metrics 为 False 时，不能为 "user"。
  - Allowed values: `none`, `voice`, `voice_multiplier`, `user`, `groups`, `api_keys`, `all_api_keys`, `product_type`, `model`, `resource`, `request_queue`, `region`, `subresource_id`, `reporting_workspace_id`, `has_api_key`, `request_source`
- `aggregation_interval` (enum, optional) — 如何按时间汇总使用数据。可为 "hour"、"day"、"week"、"month" 或 "cumulative"。
  - Allowed values: `hour`, `day`, `week`, `month`, `cumulative`
- `aggregation_bucket_size` (integer, optional, nullable) — 聚合时间桶大小（秒）。会覆盖聚合间隔。
- `metric` (enum, optional) — 要聚合的指标。
  - Allowed values: `credits`, `tts_characters`, `minutes_used`, `request_count`, `ttfb_avg`, `ttfb_p95`, `fiat_units_spent`, `concurrency`, `concurrency_average`

## Response

### 200

成功响应

- `time` (list of integer, required) — 包含每日 Unix 时间戳的时间轴。
- `usage` (map from string to list of double, required) — 时间轴上各细分类型的使用量。

## Errors

### 422 Unprocessable Entity Error

验证错误。

- `detail` (list of ValidationError, optional)

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "time": [
    1738252091000,
    1739404800000
  ],
  "usage": {
    "All": [
      49,
      1053
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/usage/character-stats"

querystring = {"end_unix":"1688165999","start_unix":"1685574000"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/usage/character-stats?end_unix=1688165999&start_unix=1685574000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```