Skip to main content
GET
Read a time-series field across a config's records

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id
string
required

ID of a record configuration whose history.mode is timeseries. The literal path segment "series" is matched before the {id} parameter of /records/{config_id}/{id}, so a record cannot be named "series".

Query Parameters

field
string
required

One of the config's history.series.fields.

record_ids
string

Comma-separated record ids to narrow to, at most 50. Omitted reads every record under the config.

start
string

RFC3339 or YYYY-MM-DD, inclusive lower bound on effective_at.

end
string

RFC3339 or YYYY-MM-DD (end of that UTC day), inclusive upper bound on effective_at.

limit
integer
default:1000

Default 1000, clamped to 1000.

Required range: x <= 1000
offset
integer
default:0

Default 0, at most 10000.

Required range: x <= 10000

Response

Series points for the requested field, ascending by effective_at then record_id. Buckets whose payload lacks the field are omitted from results but counted in total_hits.

status_code
integer

HTTP status code echoed in the response body.

body
object

get.record-series reply, ascending by effective_at then record_id.