Skip to main content

Stream time-series data for a form

GET 

/timeseries/forms/:formId/stream

Resolves the signal group of the given form and streams its time series as newline-delimited JSON (application/x-ndjson), one row per timestamp carrying each signal's value, optionally aggregated by the given aggregation type. Unlike on the sibling streams, startDate and endDate are optional here: an absent start is the oldest data point stored for the group's metrics, an absent end the newest, so a request naming neither streams every available data point - the form export's default. The bounds actually read are the ones GET /timeseries/group/{signalGroupId}/metadata reports for the same request.

Request​

Responses​

OK. If the stream breaks off after its first lines were sent - the status is already 200 - it ends with one TimeseriesStreamErrorDto line instead of a data point (HET-1985). A reader that meets a line with an error member has an incomplete series, not a short one.