Skip to main content
GET
Retrieve a dispatch timeline

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Query Parameters

start_time
string<date-time>
required

Start of the window, in UTC. May be in the past.

Example:

"2026-07-12T18:00:00Z"

end_time
string<date-time>
required

End of the window, in UTC. At most 90 days after start_time.

Example:

"2026-07-14T18:00:00Z"

aggregate_by
enum<string>

Aggregation period: NON_FIXED (default, native resolution), HALF_HOUR, HOUR or DAY.

Available options:
NON_FIXED,
HALF_HOUR,
HOUR,
DAY
Example:

"NON_FIXED"

Response

Dispatch timeline response.

Net flows at the device connection point over the window. Future intervals are forecast from instructions, confirmations and telemetry; past ones derive from meter records, confidence 1 where metered. Intervals are contiguous.

object
enum<string>
required

Object type, dispatch_timeline.

Available options:
dispatch_timeline
Example:

"dispatch_timeline"

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

live_mode
boolean
required

true for live data, false for test data.

timezone
string
required

IANA timezone at the device's location.

Example:

"Europe/London"

data
DispatchTimelineInterval · object[]
required

Contiguous forecast intervals covering the full window.

oem_id
string
required

Flatpeak OEM ID: the OEM that connects the device.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"