curl --request GET \
--url https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage")
.header("X-API-Key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"account_id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"granularity": "hour",
"group_by": [
"agent"
],
"tz": "UTC"
},
"data": [
{
"ts": "2023-11-07T05:31:56Z",
"values": [
{
"seconds": 1,
"conversations": 1,
"dimensions": {}
}
]
}
]
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}Get usage analytics
Aggregate conversation usage for the specified account. Supports configurable time ranges, bucket granularity, and optional groupings by agent, subaccount, or conversation type.
curl --request GET \
--url https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage")
.header("X-API-Key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.itellico.ai/v1/accounts/{account_id}/analytics/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"account_id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"granularity": "hour",
"group_by": [
"agent"
],
"tz": "UTC"
},
"data": [
{
"ts": "2023-11-07T05:31:56Z",
"values": [
{
"seconds": 1,
"conversations": 1,
"dimensions": {}
}
]
}
]
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}Authorizations
Path Parameters
Query Parameters
Start timestamp (ISO-8601). Defaults to 30 days before end.
End timestamp (ISO-8601). Defaults to now.
Bucket granularity for aggregation.
hour, day, month Dimensions to break results by (comma separated or repeated query params).
Dimensions for grouping usage analytics.
Attributes: AGENT: Group by individual agent. SUBACCOUNT: Group by subaccount (child team). TYPE: Group by conversation type.
agent, subaccount, type IANA timezone name used for bucket boundaries (default UTC).
Maximum number of time buckets to return (default 500).
1 <= x <= 500Response
OK
Complete usage analytics response payload.
Attributes: meta: Metadata about the query and response. data: List of time buckets with aggregated usage values.
Metadata describing the usage analytics response.
Attributes: account_id: UUID of the account for this usage data. start: Start datetime of the query range. end: End datetime of the query range. granularity: Time bucket granularity used. group_by: Grouping dimensions requested. tz: Timezone applied to bucket boundaries.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?