Data Raw Series

post

https://api.surfact.com/api/v1.6/data/raw/series

Retrieve raw (unaggregated) data from one or multiple variables within a specified time range. Allows selecting specific columns to return.

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 retrieve data for

variables*

columns

array of strings

required

Columns to include in the response. variable.properties and value.context return JSON objects rather than scalars — the variable's colour is the _color key of the variable.properties object. Any value outside this list, variable.properties.color included, is rejected with HTTP 400.

columns*

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 to return per variable, not per response. 0 means no limit and returns the whole series; the minimum accepted value is 0 (-1 is rejected with HTTP 400). When omitted, the implicit 100-point default applies only if neither start nor end is supplied — with a time range and no limit, the whole matching series is returned.

string

Timezone for the results (IANA timezone name)

precision

integer

Number of decimal places for numeric values

Responses

200Raw time-series data for the requested variables

400Validation failed — most often an unsupported entry in columns, which is reported per index under detail.columns.

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.