POST
/
aggregate
/
v1
/
user
/
{user_id}
/
query

Aggregation API is currently in closed beta. The query schema and the behaviour is subject to change based on beta feedback.

JSON is the default output format. Each query instruction outputs one entry containing a dataframe to the $.results array, in the declaration order of the query instructions.

{
    "results": [
        "table": {
            "index": [...],
            "min": [...],
            "max": [...],
            "mean": [...],
            "newest": [...]
        }
    ]
}

Specify Accept: application/vnd.vital.tar+gzip+parquet in your request header.

The response body is a gzipped Tarball of multiple Parquet files, namely 0.parquet, 1.parquet, 2.parquet, etc. The numbering corresponds to the declaration order of the query instructions.

Authorizations

x-vital-api-key
string
headerrequired

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
timeframe
object
required
queries
object[]
required
config
object

Response

200 - application/json
results
object[]
required