curl --request GET \
--url 'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z' \
--header 'Authorization: Bearer synthra_live_abc123def456'
const response = await fetch(
'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z',
{
headers: {
'Authorization': `Bearer ${process.env.SYNTHRA_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.synthra.ai/v1/analytics/metrics',
headers={
'Authorization': f'Bearer {api_key}'
},
params={
'startDate': '2024-03-01T00:00:00Z',
'endDate': '2024-03-08T23:59:59Z'
}
)
{
"period": {
"start": "2024-03-01T00:00:00Z",
"end": "2024-03-08T23:59:59Z",
"granularity": "day"
},
"sessions": {
"total": 1847,
"active": 342,
"averageDuration": 1847
},
"messages": {
"total": 15293,
"averagePerSession": 8.3,
"userMessages": 7647,
"assistantMessages": 7646
},
"tokens": {
"total": 184729,
"prompt": 92364,
"completion": 92365,
"averagePerMessage": 12.1
}
}
Analytics
Get Metrics
Retrieve usage metrics and statistics
GET
/
v1
/
analytics
/
metrics
curl --request GET \
--url 'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z' \
--header 'Authorization: Bearer synthra_live_abc123def456'
const response = await fetch(
'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z',
{
headers: {
'Authorization': `Bearer ${process.env.SYNTHRA_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.synthra.ai/v1/analytics/metrics',
headers={
'Authorization': f'Bearer {api_key}'
},
params={
'startDate': '2024-03-01T00:00:00Z',
'endDate': '2024-03-08T23:59:59Z'
}
)
{
"period": {
"start": "2024-03-01T00:00:00Z",
"end": "2024-03-08T23:59:59Z",
"granularity": "day"
},
"sessions": {
"total": 1847,
"active": 342,
"averageDuration": 1847
},
"messages": {
"total": 15293,
"averagePerSession": 8.3,
"userMessages": 7647,
"assistantMessages": 7646
},
"tokens": {
"total": 184729,
"prompt": 92364,
"completion": 92365,
"averagePerMessage": 12.1
}
}
Authorization
string
required
Bearer token. Format:
Bearer synthra_live_abc123def456Query Parameters
string
required
Start date in ISO 8601 format
string
required
End date in ISO 8601 format
string
default:"day"
Data granularity. Options:
hour, day, week, monthResponse
object
Time period for metrics
object
Session statistics
object
Message statistics
object
Token usage statistics
curl --request GET \
--url 'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z' \
--header 'Authorization: Bearer synthra_live_abc123def456'
const response = await fetch(
'https://api.synthra.ai/v1/analytics/metrics?startDate=2024-03-01T00:00:00Z&endDate=2024-03-08T23:59:59Z',
{
headers: {
'Authorization': `Bearer ${process.env.SYNTHRA_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.synthra.ai/v1/analytics/metrics',
headers={
'Authorization': f'Bearer {api_key}'
},
params={
'startDate': '2024-03-01T00:00:00Z',
'endDate': '2024-03-08T23:59:59Z'
}
)
{
"period": {
"start": "2024-03-01T00:00:00Z",
"end": "2024-03-08T23:59:59Z",
"granularity": "day"
},
"sessions": {
"total": 1847,
"active": 342,
"averageDuration": 1847
},
"messages": {
"total": 15293,
"averagePerSession": 8.3,
"userMessages": 7647,
"assistantMessages": 7646
},
"tokens": {
"total": 184729,
"prompt": 92364,
"completion": 92365,
"averagePerMessage": 12.1
}
}
⌘I