Skip to main content
GET
List device meter records

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

cursor
string

Pagination cursor. Pass next_cursor from the previous response unchanged; omit for the first page. A cursor used with different parameters returns 400 cursor_invalid.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

limit
integer
default:100

Records per page. Default 100, maximum 25000: a full year of half-hourly records.

Required range: 1 <= x <= 25000
Example:

100

aggregate_by
enum<string>

Aggregation period: NON_FIXED (default, original intervals), HALF_HOUR, HOUR, DAY, WEEK or MONTH.

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

"NON_FIXED"

flow_basis
enum<string>
default:NET

NET (default): one record per interval, import netted against export. GROSS: import and export as separate records, distinguished by sign.

Available options:
NET,
GROSS
Example:

"NET"

order_by
string

Ordering of returned data. NEWEST (default) returns the most recent records first. OLDEST returns records in chronological order.

Example:

"NEWEST"

start_time
string<date-time>

Start of the data window, RFC 3339, for example 2026-06-15T09:00:00Z or 2026-06-15T08:00:00+01:00. If the offsets of start_time and end_time differ, end_time wins.

Example:

"2026-11-07T05:31:56Z"

end_time
string<date-time>

End of the data window, RFC 3339, for example 2026-06-15T13:00:00Z or 2026-06-15T12:00:00+01:00. If the offsets of start_time and end_time differ, end_time wins. Maximum range: 90 days.

Example:

"2026-11-07T05:31:56Z"

Response

Device meter records response.

A device's meter records over the requested window, one page at a time.

object
enum<string>
required

Object type, meter_records.

Available options:
meter_records
Example:

"meter_records"

device_id
string
required

Flatpeak Device ID the records belong to.

Example:

"dev_63a6087272941ef077a8fd3e"

oem_id
string
required

Flatpeak OEM ID: the OEM that connects the device.

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

"oem_6a3a8dada72cd0a249ff9528"

count
integer
required

Total number of records in the requested window, across every page. It stays the same from page to page, and data holds only the current page.

Required range: x >= 0
Example:

2

next_cursor
string | null
required

Cursor for the next page. Pass it as cursor. null on the last page. Page until it is null, even if data is short or empty.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

data
MeterRecord · object[]
required

The page of meter records, one per interval.