Skip to content

Fetch information stream data points

Request

Requires scope: forecasting.

Returns data points for a single information stream.

The timestamps specify the lower bound of the time window, where the window is granularity long. For example, if granularity="hour", the value at "2026-04-02 11:00:00" indicates the value between "2026-04-02 11:00:00" and "2026-04-02 12:00:00".

If granularity is not provided, the configured granularity of the information stream will be used.

Security
apiKey(Required scopes: forecasting)
Query
keystringrequired

Information stream identifier (stream key) to filter by. Required: omitting it currently results in a 500 rather than a 400.

Example:key=covers-per-hour-pier9
startDatestring, (date)required

Start date of the information stream data in YYYY-MM-DD format

Example:startDate=2026-06-01
endDatestring, (date)required

End date of the information stream data in YYYY-MM-DD format

Example:endDate=2026-06-30
granularitystring

Granularity of the information stream data to group by.

If not provided, the configured granularity of the information stream will be used.

If provided, it must be coarser than the information stream's granularity. Then, the data will be summed/grouped to the specified granularity.

Enum:"hour""day""week""month""quarter""year"
curl -i -X GET \
  'https://beta-developer.dyflexis.com/_mock/openapi/information-streams/v3/data-points?key=covers-per-hour-pier9&startDate=2026-06-01&endDate=2026-06-30&granularity=hour' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Response code 200 - OK

Bodyapplication/json
property name*objectadditional property

Map of timestamp strings to data point objects for that granularity

Response
{ "day": { "2026-05-01": {}, "2026-07-21": {} }, "hour": { "2026-07-20 00:00:00": {}, "2026-07-20 03:00:00": {} }, "week": { "2026-W29": {} } }