POST
/
aggregate
/
v1
/
user
/
{user_id}
/
query
curl --request POST \
  --url https://api.tryvital.io/aggregate/v1/user/{user_id}/query \
  --header 'Content-Type: application/json' \
  --header 'x-vital-api-key: <api-key>' \
  --data '{
  "timeframe": {
    "type": "<string>",
    "anchor": "2023-12-25",
    "past": {
      "value": 2,
      "unit": "minute"
    }
  },
  "queries": [
    {
      "select": [
        {
          "arg": {
            "sleep": "session_start"
          },
          "func": "mean"
        }
      ],
      "group_by": [
        {
          "date_trunc": {
            "value": 2,
            "unit": "minute"
          },
          "arg": {
            "index": "sleep"
          }
        }
      ],
      "split_by_source": false
    }
  ],
  "config": {
    "provider_priority_overrides": [
      "oura"
    ]
  }
}'
{
  "results": [
    {
      "table": {}
    }
  ]
}

Horizon AI Query is in closed beta.

Interested in the Horizon AI Query? Get in touch with your Customer Success Manager.

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Headers

​
accept
enum<string>
default:*/*
Available options:
*/*,
application/json,
application/vnd.vital.tar+gzip+parquet

Path Parameters

​
user_id
string
required

Body

application/json

Response

200
application/json
Successful Response

The response is of type object.