Archived sessions

get

https://api.zaptec.com/api/sessions/archived

Retrieves completed charge sessions accessible by the current user, filtered by date range and exactly one of: an installation, a single charger, or an authorized user (the calling user's own id; support may pass any user's id). Results are returned in cursor-paginated pages in the requested order (oldest first by default); when hasMore is true, send the returned cursor as ?cursor= on the next request to fetch the next page. Default page size: 50. Max: 200.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

From

date-time

Inclusive lower bound for session end time. Required.

date-time

Exclusive upper bound for session end time. Required, must be after from.

InstallationId

uuid

Installation to list sessions for. Requires owner role on the installation.
Exactly one of installationId, chargerId or authorizedUserId is required.

ChargerId

uuid

Single charger to list sessions for. Requires owner role on the charger.
Exactly one of installationId, chargerId or authorizedUserId is required.

AuthorizedUserId

uuid

User whose sessions to list. Must be the id of the calling user, unless the caller
has an Administrator permission covering that user (support access).
Exactly one of installationId, chargerId or authorizedUserId is required.

PageSize

int32

Page size. Default 50, max 200.

Order

int32

enum

Sort order, by the time the session was recognized by the archive.
Defaults to RecognizedTimeAscending (oldest first).

0 = RecognizedTimeAscending

1 = RecognizedTimeDescending

Allowed:

Cursor

string

Opaque cursor from a previous response's cursor field. Omit to start from the first page.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden