Request
Prompt
- POSTQuery Prompts
- POSTQuery Prompt
- DELDelete Prompt
- POSTCreate Prompt
- POSTEdit Prompt Version Label
- POSTEdit Prompt Version Template
- POSTGet Prompt Version Subversion
- POSTPromote Prompt Version
- POSTQuery Prompt Version Inputs
- GETGet Prompt Experiments
- POSTQuery Prompt Versions
- GETGet Prompt Version
- DELDelete Prompt Version
- POSTCompile Prompt
- POSTQuery Prompt Template
Evals
Evaluator
Experiment
- POSTCreate Empty Experiment (v2)
- POSTCreate from Request (v2)
- POSTCreate New Experiment (v2)
- GETList Experiments
- GETGet Experiment Details
- POSTAdd Prompt Version
- GETGet Experiment Prompt Versions
- GETGet Experiment Input Keys
- POSTAdd Manual Row (v2)
- POSTBatch Insert Rows (v2)
- POSTPost v2experiment rowupdate
- POSTPost v2experiment run hypothesis
- GETGet Experiment Evaluators (v2)
- POSTAdd Evaluators (v2)
- DELDelete Experiment Evaluator (v2)
- POSTRun Evaluators (v2)
- GETCheck Evaluator Run Status
- GETGet Experiment Scores
- GETGet Experiment Score
- POSTCreate Empty Experiment
- POSTCreate New Table
- POSTQuery Experiment Table
- POSTQuery Table Metadata
- POSTQuery Tables
- POSTCreate Table Cell
- PATCHUpdate Experiment Table Cell
- POSTCreate Table Column
- POSTCreate New Table Row
- DELDelete Experiment Table Row
- POSTBatch Insert Table Rows
- POSTUpdate Metadata
- POSTCreate Experiment
- POSTCreate Experiment Hypothesis
- POSTQuery Hypothesis Scores
- GETGet Experiment Evaluators
- POSTAdd Experiment Evaluators
- POSTRun Experiment Evaluators
- DELDelete Experiment Evaluator
- POSTQuery Experiments
Property
Dataset
Dashboard
Settings
Query User Metrics Overview
Get an overview of aggregated user metrics
curl --request POST \
--url https://api.helicone.ai/v1/user/metrics-overview/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"useInterquartile": true,
"pSize": "p50",
"filter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"response_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"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": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"target_url": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"properties": {},
"search_properties": {},
"scores": {},
"scores_column": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_body": {
"contains": "<string>"
},
"response_body": {
"contains": "<string>"
}
},
"user_metrics": {
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"last_active": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"total_requests": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"active_for": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"average_requests_per_day_active": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"average_tokens_per_request": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"cost": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
}
}
}
}'
{
"data": {
"user_cost": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 123
}
],
"request_count": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 123
}
]
}
}
Authorizations
Body
From T, pick a set of properties whose keys are in the union K
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
Make all properties in T optional
p50
, p75
, p95
, p99
, p99.9
Response
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/user/metrics-overview/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"useInterquartile": true,
"pSize": "p50",
"filter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"status": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"request_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"response_created_at": {
"gte": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"gt": "2023-11-07T05:31:56Z"
},
"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": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"target_url": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"properties": {},
"search_properties": {},
"scores": {},
"scores_column": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"request_body": {
"contains": "<string>"
},
"response_body": {
"contains": "<string>"
}
},
"user_metrics": {
"user_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"last_active": {
"gte": "<string>",
"lte": "<string>",
"lt": "<string>",
"gt": "<string>"
},
"total_requests": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"active_for": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"average_requests_per_day_active": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"average_tokens_per_request": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_completion_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"total_prompt_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"cost": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
}
}
}
}'
{
"data": {
"user_cost": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 123
}
],
"request_count": [
{
"range_start": "<string>",
"range_end": "<string>",
"value": 123
}
]
}
}