Get User Data

Retrieve user data based on specified user IDs and time filters

1 min read

post/v1/user/query

Request example

curl --request POST \
  --url https://api.helicone.ai/v1/user/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userIds": [
    "<string>"
  ],
  "timeFilter": {
    "endTimeUnixSeconds": 1,
    "startTimeUnixSeconds": 1
  }
}'

Response

{
  "data": [
    {
      "cost": 1,
      "user_id": "<string>",
      "completion_tokens": 1,
      "prompt_tokens": 1,
      "count": 1
    }
  ],
  "error": null
}

post/v1/user/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

userIdsstring[]#

timeFilterobject#

Show child attributes

endTimeUnixSecondsnumberrequired#

startTimeUnixSecondsnumberrequired#

Responses

application/json

200

Any of

dataobject[]required#

Show child attributes

costnumberrequired#

user_idstringrequired#

completion_tokensnumberrequired#

prompt_tokensnumberrequired#

countnumberrequired#

errorenum<number>required#

Options:null

dataenum<number>required#

Options:null

errorstringrequired#

Query User Metrics Query Evaluations