Skip to main content
POST
Get time-series chart data for histories

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
granularity
enum<string>
required

Time granularity for bucketing

Available options:
day,
week,
month,
hour
Example:

"month"

range
integer
required

Time range (negative values for past periods)

Example:

-3

dimension
enum<string>
required

Metric to aggregate

Available options:
count,
credits,
usage,
cached,
price
Example:

"count"

institution
string

Institution ID (optional, filters by institution)

Example:

"65cfebc32f5e1b37d4e52329"

account
string

Account ID (optional, filters by account's institutions)

aggregate
boolean

When true, aggregates across all institutions

Example:

false

topsearch
integer

Number of top institutions to return (default 5, -1 for all)

Example:

5

Response

Successfully retrieved timeline chart data

success
boolean

Indicates if the request was successful

data
object[]

Array of chart data points