Skip to navigation
Analytics SDKAnalytics APIAnalytics SaaS

Getsaaslogs

View as Markdown

Business request-log list with pagination metadata.

Time window — provide one of:

  • dateFrom + dateTo (YYYY-MM-DD), or
  • start + end (ISO 8601 datetimes).

If both pairs are present, the ISO start/end pair wins.

Filters: at most one of agentId vs memberId; do not combine entityType with agent/member ids (40028). entityType ∈ agent | user | member (member maps to user internally). search non-empty must be UUID (40027). masterKeyId / departmentId optional UUIDs.

Pagination: limit (default 20, max 200), offset or page + optional pageSize.

Success data: { "period", "data": [...], "meta": { "total", "hasMore", "limit", "offset", ... } }

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

dateFromstringOptional

Calendar start YYYY-MM-DD (use with dateTo unless ISO pair used).

dateTostringOptional

Calendar end YYYY-MM-DD.

startdatetimeOptional

ISO 8601 start (pair with end; overrides calendar pair when both pairs present).

enddatetimeOptional

ISO 8601 end; must be after start.

agentIdstringOptionalformat: "uuid"

Agent UUID; mutually exclusive with memberId.

memberIdstringOptionalformat: "uuid"

Member UUID; mutually exclusive with agentId.

entityTypeenumOptional

agent | user | member for type-only filter; not with agentId/memberId.

Allowed values:
masterKeyIdstringOptionalformat: "uuid"
Optional master key UUID.
departmentIdstringOptionalformat: "uuid"
Optional department UUID.
searchstringOptionalformat: "uuid"

Non-empty must be UUID (entity/user id search).

modelstringOptional
Exact model filter after trim.
limitintegerOptional1-200Defaults to 20

Page size (default 20, max 200).

offsetintegerOptional0-10000Defaults to 0

0-based offset (alternative to page).

pageintegerOptional>=1Defaults to 1

1-based page index when not using offset.

pageSizeintegerOptional1-200

Used with page (capped with limit semantics, max 200).

statusintegerOptional
HTTP status filter. Invalid values are currently ignored.

Response

This endpoint returns an object.
codeinteger
messagestring
dataany