Warning
For users in the European Union: Please use eu.api.helicone.ai instead of
api.helicone.ai.
Query User Metrics Overview
Get an overview of aggregated user metrics
1 min read
post/v1/user/metrics-overview/query
Request example
curl --request POST \
--url https://api.helicone.ai/v1/user/metrics-overview/query \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"useInterquartile": true,
"pSize": "p50",
"filter": {
"request_response_rmt": {
"country_code": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"latency": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"cost": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"provider": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"time_to_first_token": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"status": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"request_created_at": {
"equals": "2026-08-10T12:00:00Z",
"gte": "2026-08-10T12:00:00Z",
"lte": "2026-08-10T12:00:00Z",
"lt": "2026-08-10T12:00:00Z",
"gt": "2026-08-10T12:00:00Z"
},
"response_created_at": {
"equals": "2026-08-10T12:00:00Z",
"gte": "2026-08-10T12:00:00Z",
"lte": "2026-08-10T12:00:00Z",
"lt": "2026-08-10T12:00:00Z",
"gt": "2026-08-10T12:00:00Z"
},
"model": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"organization_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"node_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"job_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"threat": {
"equals": true
},
"request_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"completion_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"prompt_cache_read_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"prompt_cache_write_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"total_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"target_url": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"property_key": {
"equals": "<string>"
},
"properties": {},
"search_properties": {},
"scores": {},
"scores_column": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_body": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"response_body": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"cache_enabled": {
"equals": true
},
"cache_reference_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"cached": {
"equals": true
},
"assets": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"helicone-score-feedback": {
"equals": true
},
"prompt_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"prompt_version": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_referrer": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"is_passthrough_billing": {
"equals": true
}
},
"users_view": {
"user_user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"user_active_for": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_first_active": {
"equals": "2026-08-10T12:00:00Z",
"gte": "2026-08-10T12:00:00Z",
"lte": "2026-08-10T12:00:00Z",
"lt": "2026-08-10T12:00:00Z",
"gt": "2026-08-10T12:00:00Z"
},
"user_last_active": {
"equals": "2026-08-10T12:00:00Z",
"gte": "2026-08-10T12:00:00Z",
"lte": "2026-08-10T12:00:00Z",
"lt": "2026-08-10T12:00:00Z",
"gt": "2026-08-10T12:00:00Z"
},
"user_total_requests": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_average_requests_per_day_active": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_average_tokens_per_request": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_total_completion_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_total_prompt_tokens": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
},
"user_cost": {
"not-equals": 1,
"equals": 1,
"gte": 1,
"lte": 1,
"lt": 1,
"gt": 1
}
}
}
}'Response
{
"data": {
"user_cost": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 1
}
],
"request_count": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 1
}
]
},
"error": null
}post/v1/user/metrics-overview/query
Authorization
Bearer token authentication. Format: 'Bearer YOUR_API_KEY'
Body
application/jsonResponses
application/json
200
Ok