Data Aggregation

post

https://api.surfact.com/api/v1.6/data/stats/aggregation/

Aggregate data from one or multiple variables within a specified time range. Supports multiple aggregation functions and optional timezone and precision settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

token

string

Alternative authentication token (use instead of X-Auth-Token header)

Body Params

variables

array of strings

required

List of variable IDs to aggregate

variables*

aggregation

string

enum

required

Aggregation function to apply. raw returns the last raw dot rather than an aggregate, and average is an alias of mean. There is no variance or standard-deviation function here: both are rejected with HTTP 400. This endpoint does not share a function set with GET /variables/{variable_id}/statistics/{aggregation}/....

join_dataframes

boolean

Defaults to true

Whether to join results into a single dataframe across all requested variables. Defaults to true when omitted.

start

int64

Start of time range as POSIX timestamp in milliseconds

end

int64

End of time range as POSIX timestamp in milliseconds

limit

integer

≥ 0

Maximum number of data points per variable to feed into the aggregation. It truncates the input series before aggregating, so it materially changes the answer. 0 means no limit; the minimum accepted value is 0. When neither start nor end is supplied, the last 100 points per variable are used.

string

Timezone for the aggregation (IANA timezone name)

precision

integer

Number of decimal places for result values

Responses

200Aggregated data results

400Bad request (e.g. JSON parse error)

401Authentication failed. Surfact returns the same code, 401002, whether the token is missing, empty or wrong.

403Requested time range is older than the account's data retention window.