Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-244065126.5 KB
Consumption

List Datapoint Access Events by date range

Return the individual datapoint access events for the authenticated user within a date window.

Inputs

  • start_at and end_at are dates (YYYY-MM-DD).
  • Internally, start_at expands to the start of that day in the current Django timezone; end_at expands to the end of that day in the current Django timezone.

Defaults

  • If start_at is omitted, it defaults to the first day of the current month at 00:00:00 (current timezone).
  • If end_at is omitted, it defaults to now (current datetime in the current timezone).

Behavior

  • The window is inclusive: start_at ≤ timestamp ≤ end_at.
  • Results are ordered by timestamp ascending.

Response

  • A paginated list of datapoint access events.
get/api/v2/consumption/events

Query parameters

end_atstring date

End date (YYYY-MM-DD) of the inclusive window. Defaults to today's date (and current time) if omitted.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return results.

start_atstring date

Start date (YYYY-MM-DD) of the inclusive window. Defaults to the first day of the current month if omitted.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}