Analytics SDKAnalytics APIAnalytics Atomic

Getsessions

View as Markdown

Session analytics list for the last 7 days. The server currently derives the start window internally and supports app-layer status filtering.

Success data: { "data": [...], "meta": { "total", "page", "pageSize", "hasMore" } }.

Authentication

AuthorizationBearer
Bearer credential containing a JWT, Virtual Key, or PAT.

Headers

X-Workspace-IdstringOptionalformat: "uuid"

Required for a normal JWT, Virtual Key, or PAT. A JWT may instead send X-Openmodel-User-Id. Not used by the public health endpoint.

X-Openmodel-User-IdstringOptionalformat: "uuid"

JWT-only alternative to X-Workspace-Id. Must be a UUID equal to the JWT subject; the server uses it as the workspace id. Not valid as the sole workspace header for Virtual Key or PAT authentication.

Query parameters

startdatetimeOptional

ISO 8601 start; defaults to seven days before the request.

enddatetimeOptional
Optional ISO 8601 end bound.
pageintegerOptional>=1Defaults to 1

1-based page index (default 1).

pageSizeintegerOptional1-100Defaults to 20

Page size (default 20, max 100).

statusenumOptional

Optional filter. One of active, completed, intercepted.

Allowed values:
agentIdstringOptional

Preferred agent id filter; takes precedence over agent.

agentstringOptional
Optional agent id filter.
departmentIdstringOptional
Optional department id filter.
searchstringOptional
Optional search string.
sortenumOptional
Optional sort key.
Allowed values:
orderenumOptional

Optional sort order (asc or desc).

Allowed values:

Response

codeinteger
messagestring
dataany