Query Session Metrics

Search and analyze session performance metrics

1 min read

post/v1/session/metrics/query

Request example

curl --request POST \
  --url https://api.helicone.ai/v1/session/metrics/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "nameContains": "<string>",
  "timezoneDifference": 1,
  "pSize": "p50",
  "useInterquartile": true,
  "timeFilter": {
    "startTimeUnixMs": 1,
    "endTimeUnixMs": 1
  },
  "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
      }
    },
    "sessions_request_response_rmt": {
      "session_session_id": {
        "not-equals": "<string>",
        "equals": "<string>",
        "like": "<string>",
        "ilike": "<string>",
        "contains": "<string>",
        "not-contains": "<string>"
      },
      "session_session_name": {
        "not-equals": "<string>",
        "equals": "<string>",
        "like": "<string>",
        "ilike": "<string>",
        "contains": "<string>",
        "not-contains": "<string>"
      },
      "session_total_cost": {
        "not-equals": 1,
        "equals": 1,
        "gte": 1,
        "lte": 1,
        "lt": 1,
        "gt": 1
      },
      "session_total_tokens": {
        "not-equals": 1,
        "equals": 1,
        "gte": 1,
        "lte": 1,
        "lt": 1,
        "gt": 1
      },
      "session_prompt_tokens": {
        "not-equals": 1,
        "equals": 1,
        "gte": 1,
        "lte": 1,
        "lt": 1,
        "gt": 1
      },
      "session_completion_tokens": {
        "not-equals": 1,
        "equals": 1,
        "gte": 1,
        "lte": 1,
        "lt": 1,
        "gt": 1
      },
      "session_total_requests": {
        "not-equals": 1,
        "equals": 1,
        "gte": 1,
        "lte": 1,
        "lt": 1,
        "gt": 1
      },
      "session_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"
      },
      "session_latest_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"
      },
      "session_tag": {
        "not-equals": "<string>",
        "equals": "<string>",
        "like": "<string>",
        "ilike": "<string>",
        "contains": "<string>",
        "not-contains": "<string>"
      }
    }
  }
}'

Response

{
  "data": {
    "session_count": [
      {
        "range_start": "<string>",
        "range_end": "<string>",
        "value": 1
      }
    ],
    "session_duration": [
      {
        "range_start": "<string>",
        "range_end": "<string>",
        "value": 1
      }
    ],
    "session_cost": [
      {
        "range_start": "<string>",
        "range_end": "<string>",
        "value": 1
      }
    ],
    "average": {
      "session_cost": [
        {
          "average": 1
        }
      ],
      "session_duration": [
        {
          "average": 1
        }
      ],
      "session_count": [
        {
          "average": 1
        }
      ]
    }
  },
  "error": null
}

post/v1/session/metrics/query

Warning

For users in the European Union: Please use eu.api.helicone.ai instead of api.helicone.ai.

Authorization

Authorizationstringheaderrequired#

Bearer token authentication. Format: 'Bearer YOUR_API_KEY'

Body

application/json

nameContainsstringrequired#

timezoneDifferencenumberrequired#

pSizeenum<string>#

Options:p50p75p95p99p99.9

useInterquartileboolean#

timeFilterobject#

Show child attributes

startTimeUnixMsnumberrequired#

endTimeUnixMsnumberrequired#

filterobject · enum<string>#

Show child attributes

Any of

request_response_rmtobject#

Make all properties in T optional

Show child attributes

country_codeobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

latencyobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

costobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

providerobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

time_to_first_tokenobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

statusobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

request_created_atobject#

Make all properties in T optional

Show child attributes

equalsstring#

gtestring#

ltestring#

ltstring#

gtstring#

response_created_atobject#

Make all properties in T optional

Show child attributes

equalsstring#

gtestring#

ltestring#

ltstring#

gtstring#

modelobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

user_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

organization_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

node_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

job_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

threatobject#

Make all properties in T optional

Show child attributes

equalsboolean#

request_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

prompt_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

completion_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

prompt_cache_read_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

prompt_cache_write_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

total_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

target_urlobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

property_keyobject#

Show child attributes

equalsstringrequired#

propertiesobject#

Show child attributes

{key}object#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

search_propertiesobject#

Show child attributes

{key}object#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

scoresobject#

Show child attributes

{key}object#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

scores_columnobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

request_bodyobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

response_bodyobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

cache_enabledobject#

Make all properties in T optional

Show child attributes

equalsboolean#

cache_reference_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

cachedobject#

Make all properties in T optional

Show child attributes

equalsboolean#

assetsobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

helicone-score-feedbackobject#

Make all properties in T optional

Show child attributes

equalsboolean#

prompt_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

prompt_versionobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

request_referrerobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

is_passthrough_billingobject#

Make all properties in T optional

Show child attributes

equalsboolean#

sessions_request_response_rmtobject#

Make all properties in T optional

Show child attributes

session_session_idobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

session_session_nameobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

session_total_costobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

session_total_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

session_prompt_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

session_completion_tokensobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

session_total_requestsobject#

Make all properties in T optional

Show child attributes

not-equalsnumber#

equalsnumber#

gtenumber#

ltenumber#

ltnumber#

gtnumber#

session_created_atobject#

Make all properties in T optional

Show child attributes

equalsstring#

gtestring#

ltestring#

ltstring#

gtstring#

session_latest_request_created_atobject#

Make all properties in T optional

Show child attributes

equalsstring#

gtestring#

ltestring#

ltstring#

gtstring#

session_tagobject#

Make all properties in T optional

Show child attributes

not-equalsstring#

equalsstring#

likestring#

ilikestring#

containsstring#

not-containsstring#

rightSessionFilterNoderequired#

circular

operatorenum<string>required#

Options:orand

leftSessionFilterNoderequired#

circular

Responses

application/json

200

Any of

dataobjectrequired#

Show child attributes

session_countobject[]required#

Show child attributes

range_startstringrequired#

range_endstringrequired#

valuenumberrequired#

session_durationobject[]required#

Show child attributes

range_startstringrequired#

range_endstringrequired#

valuenumberrequired#

session_costobject[]required#

Show child attributes

range_startstringrequired#

range_endstringrequired#

valuenumberrequired#

averageobjectrequired#

Show child attributes

session_costobject[]required#

Show child attributes

averagenumberrequired#

session_durationobject[]required#

Show child attributes

averagenumberrequired#

session_countobject[]required#

Show child attributes

averagenumberrequired#

errorenum<number>required#

Options:null

dataenum<number>required#

Options:null

errorstringrequired#

Query Sessions Add Session Feedback