Retrieve and filter dashboard scoring metrics
curl --request POST \
--url https://api.helicone.ai/v1/dashboard/scores/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"timeFilter": {
"end": "<string>",
"start": "<string>"
},
"userFilter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"time_to_first_token": {
"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": {
"equals": "2023-11-07T05:31:56Z",
"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": {
"equals": "2023-11-07T05:31:56Z",
"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
},
"prompt_cache_read_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_cache_write_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>"
},
"cache_enabled": {
"equals": true
},
"cache_reference_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"assets": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"helicone-score-feedback": {
"equals": true
}
}
},
"dbIncrement": "min",
"timeZoneDifference": 123
}'
{
"userFilter": "all",
"timeFilter": {
"start": "2024-01-01",
"end": "2024-01-31"
},
"dbIncrement": "day",
"timeZoneDifference": 0
}
For users in the European Union: Please use eu.api.helicone.ai
instead of
api.helicone.ai
.
Ok
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/dashboard/scores/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"timeFilter": {
"end": "<string>",
"start": "<string>"
},
"userFilter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"time_to_first_token": {
"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": {
"equals": "2023-11-07T05:31:56Z",
"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": {
"equals": "2023-11-07T05:31:56Z",
"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
},
"prompt_cache_read_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_cache_write_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>"
},
"cache_enabled": {
"equals": true
},
"cache_reference_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"assets": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"helicone-score-feedback": {
"equals": true
}
}
},
"dbIncrement": "min",
"timeZoneDifference": 123
}'
{
"userFilter": "all",
"timeFilter": {
"start": "2024-01-01",
"end": "2024-01-31"
},
"dbIncrement": "day",
"timeZoneDifference": 0
}
Retrieve and filter dashboard scoring metrics
curl --request POST \
--url https://api.helicone.ai/v1/dashboard/scores/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"timeFilter": {
"end": "<string>",
"start": "<string>"
},
"userFilter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"time_to_first_token": {
"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": {
"equals": "2023-11-07T05:31:56Z",
"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": {
"equals": "2023-11-07T05:31:56Z",
"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
},
"prompt_cache_read_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_cache_write_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>"
},
"cache_enabled": {
"equals": true
},
"cache_reference_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"assets": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"helicone-score-feedback": {
"equals": true
}
}
},
"dbIncrement": "min",
"timeZoneDifference": 123
}'
{
"userFilter": "all",
"timeFilter": {
"start": "2024-01-01",
"end": "2024-01-31"
},
"dbIncrement": "day",
"timeZoneDifference": 0
}
For users in the European Union: Please use eu.api.helicone.ai
instead of
api.helicone.ai
.
Ok
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.helicone.ai/v1/dashboard/scores/query \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"timeFilter": {
"end": "<string>",
"start": "<string>"
},
"userFilter": {
"request_response_rmt": {
"latency": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"time_to_first_token": {
"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": {
"equals": "2023-11-07T05:31:56Z",
"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": {
"equals": "2023-11-07T05:31:56Z",
"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
},
"prompt_cache_read_tokens": {
"not-equals": 123,
"equals": 123,
"gte": 123,
"lte": 123,
"lt": 123,
"gt": 123
},
"prompt_cache_write_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>"
},
"cache_enabled": {
"equals": true
},
"cache_reference_id": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"assets": {
"not-equals": "<string>",
"equals": "<string>",
"like": "<string>",
"ilike": "<string>",
"contains": "<string>",
"not-contains": "<string>"
},
"helicone-score-feedback": {
"equals": true
}
}
},
"dbIncrement": "min",
"timeZoneDifference": 123
}'
{
"userFilter": "all",
"timeFilter": {
"start": "2024-01-01",
"end": "2024-01-31"
},
"dbIncrement": "day",
"timeZoneDifference": 0
}