Get workspace usage
POST https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time Content-Type: application/json
Returns credit usage broken down by product type over time. The response is a tabular structure with columns, column_types, column_units, and rows.
Reference: https://elevenlabs.io/docs/api-reference/analytics/workspace/usage
Servers
Section titled “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
Section titled “Request”Body (application/json)
Section titled “Body (application/json)”This endpoint expects a Body_Get_Workspace_Usage_v1_workspace_analytics_query_usage_by_product_over_time_post.
start_time(integer, required) — Start of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01.end_time(integer, required) — End of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01.interval_seconds(integer, optional, default: 60) — Bucket size in seconds. Each row in the response covers this many seconds of the selected time range. For example, pass 3600 for hourly buckets, 86400 for daily buckets, or 604800 for weekly buckets. Whethertime_zoneshifts bucket boundaries depends on this value: week multiples (e.g. 604800) are calendar weeks that start Monday at local midnight; whole-day multiples that are not whole weeks (e.g. 86400) align to local midnight; whole-hour multiples up to 24 hours (e.g. 3600, 14400) align to local hour boundaries from midnight; sub-hour values and other sizes remain UTC-anchored regardless oftime_zone.group_by(list of enum, optional, nullable)- Allowed values:
product_type,model,voice_id,user_id,fiat_currency,fiat_charge_type,region,reporting_workspace_id,request_source,resource_id,subresource_id,request_queue_type,voice_multiplier,hashed_xi_api_key,billing_group_id,surface,actor
- Allowed values:
filters(list of ColumnFilter, optional, nullable)time_zone(string, optional, default: UTC) — IANA time zone identifier (e.g. 'America/New_York', 'Europe/London', 'UTC') used to align bucket boundaries for eligibleinterval_secondsvalues. Week multiples (e.g. 604800) are calendar weeks that start Monday at local midnight. Whole-day multiples that are not whole weeks start at local midnight; whole-hour multiples up to 24 hours align to local hour boundaries from midnight. Sub-hour intervals and other bucket sizes remain UTC-anchored regardless of this setting. Defaults to UTC.
Response
Section titled “Response”Successful Response
columns(list of string, required)column_types(list of enum, required)- Allowed values:
String,Float,DateTime,Int,Bool,JSON,Map,Array
- Allowed values:
rows(list of list of WorkspaceAnalyticsQueryResponseModelRowsItemsItems, required)column_units(list of enum, required)- Allowed values:
ms,s,min,duration,credits,usd,eur,inr,pln,gbp,ratio,rating
- Allowed values:
Errors
Section titled “Errors”422 Unprocessable Entity Error
Section titled “422 Unprocessable Entity Error”Validation Error
detail(list of ValidationError, optional)
ColumnFilter
Section titled “ColumnFilter”column(string, required)operation(enum, required)- Allowed values:
in,not_in,le,ge,lt,gt,eq,neq
- Allowed values:
values(list of ColumnFilterValuesItems, required)
WorkspaceAnalyticsQueryResponseModelRowsItemsItems
Section titled “WorkspaceAnalyticsQueryResponseModelRowsItemsItems”ValidationError
Section titled “ValidationError”loc(list of ValidationErrorLocItems, required)msg(string, required)type(string, required)
ColumnFilterValuesItems
Section titled “ColumnFilterValuesItems”ValidationErrorLocItems
Section titled “ValidationErrorLocItems”Examples
Section titled “Examples”Request
{
"start_time": 1,
"end_time": 1
}Response
{
"columns": [
"string"
],
"column_types": [
"String"
],
"rows": [
[
"string"
]
],
"column_units": [
"ms"
]
}SDK Code
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
async function main() {
const client = new ElevenLabsClient();
await client.workspace.usage.getUsageByProductOverTime({
startTime: 1,
endTime: 1,
});
}
main();
from elevenlabs import ElevenLabs
client = ElevenLabs()
client.workspace.usage.get_usage_by_product_over_time(
start_time=1,
end_time=1,
)
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time"
payload := strings.NewReader("{\n \"start_time\": 1,\n \"end_time\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_time\": 1,\n \"end_time\": 1\n}"
response = http.request(request)
puts response.read_bodyimport com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;
HttpResponse<String> response = Unirest.post("https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1,\n \"end_time\": 1\n}")
.asString();<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time', [
'body' => '{
"start_time": 1,
"end_time": 1
}',
'headers' => [
'Content-Type' => 'application/json',
],
]);
echo $response->getBody();using RestSharp;
var client = new RestClient("https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"start_time\": 1,\n \"end_time\": 1\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);import Foundation
let headers = ["Content-Type": "application/json"]
let parameters = [
"start_time": 1,
"end_time": 1
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/workspace/analytics/query/usage-by-product-over-time")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
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()