List session summaries using JWE payload

POST form of GET on this path. It accepts the same parameters as a flat JSON body (SessionsQueryBody) instead of a query string, and returns the same response. Use it when the request parameters must be encrypted. See “Sending parameters in a POST body” and “Payload encryption” in the API description.

• Request encryption off: send SessionsQueryBody as application/json.
• Request encryption on: send the same object encrypted as an EncryptedRequest, preferably as application/jose+json.
• Response encryption on: every response except 401 is an EncryptedResponse with X-ABL-Encrypted: true.

POST /api/public/analytics/projects/{projectId}/sessions

cURL

plain

curl --request POST \
  --url https://{host}/api/public/analytics/projects/{projectId}/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fromDate": "2026-08-01T00:00:00.000Z",
  "toDate": "2026-08-02T00:00:00.000Z",
  "channel": [
    "web_chat",
    "voice"
  ],
  "status": "ended",
  "traceDimensions": {
    "accountTier": "gold"
  },
  "limit": 100,
  "offset": 0
}
'

200

{
  "protected": "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoiNjZmN2ExYzJlNGIwYTFkMmMzZTRmNWE2IiwicGtmIjoiMzg4OTYxNmY1MGNmNTkxZWViZjEwM2FmYmJkNDYxMGQ5MGRjNzg4NjJlMTU2NDE5YzU2NTBkMDRjYWZiNjE5YyJ9",
  "encrypted_key": "TRVuJG7BSHwO9xRyWhDMXhdo7M8G3PZrfZMX2T-wLcCyvGBq3NGq6DNAFMKOPc8onZUYa5LzFvdMcWKMRTSKaG8Q4i_ZIZ6mdOyWvydWZwVotU3Mq7XAYLh7ixQSol3LnfYP2toYxJHHb-ffglOjCe1fayqkEIo81e2UnsG9ITQ6915c4jLna2qcy6qif0ZVkVzOkpesAsY3uUYlgl0FL4vZbealhm_LLSF-usycSCScq5xYEMm1GNvfG3NyP0BzSV4dYCk2FB-2xSqbqePz2OSzby5IV6-aXLqKsull4BNpMZC1HocKbxk1gE4k6dO-E0Qr2ZIGR0M68nIxY-z_Ug",
  "iv": "5yEXvNfHRftJ7b6T",
  "ciphertext": "mwqoUeYNW7bSlBMarz09bA",
  "tag": "q5cwgh7N4OEJYl5pJ6ydyA"
}

Use this endpoint to retrieve the same session-level analytics as the corresponding GET operation, but send the query parameters in a JSON request body instead of the URL query string. It supports the same filters, pagination, validation, permissions, and response format as the GET operation.

Use the POST endpoint when the request parameters must be encrypted. With request encryption enabled for the Platform Key, send the query object as a JWE encrypted request. With request encryption disabled, send the parameters as a plain JSON object. Response encryption is independent of request encryption; when enabled, responses other than 401 are returned as encrypted JWE payloads.

For filter details, see the GET endpoint help article.

Authorizations

x-api-key · string · header · required

Project-bound API key. Do not send an Authorization header with this API.

Path Parameters

projectId · string · required

Project identifier bound to the API key.

Minimum string length: 1

Body

application/jsonapplication/jose+json

Option 1

Option 2

POST form of the GET query parameters: a flat JSON object whose keys are the GET query parameter names. For a Platform Key with request encryption on, send this object encrypted as an EncryptedRequest instead.

fromDate · string<date-time>

Same as the fromDate query parameter of the GET operation.

toDate · string<date-time>

Same as the toDate query parameter of the GET operation.

sessionIds · string[] string

Same as the sessionIds query parameter of the GET operation. Send a JSON array, or a comma-separated string as in the query string.

Maximum array length: 10000

Minimum string length: 1

containmentType · enum<string>[] string

Same as the containmentType query parameter of the GET operation. Send a JSON array, or a comma-separated string as in the query string.

Maximum array length: 100

Available options: contained, contained_resolved, contained_partial, contained_unresolved, escalated, abandoned

environment · enum<string>[] string

Same as the environment query parameter of the GET operation. Send a JSON array, or a comma-separated string as in the query string.

Maximum array length: 4

Available options: dev, staging, production, working-copy

Maximum string length: 128

callerNumber · string[] string

Same as the callerNumber query parameter of the GET operation. Send a JSON array of caller values in any provider format (no URL encoding needed), or a comma-separated string. Every entry must be a string with at least one letter or digit and at most 512 characters; an empty array returns 400.

Required array length: 1 - 100 elements

Required string length: 1 - 512

Example:

["[phone]", "Anonymous"]

channelUId · string[] string

Same as the channelUId query parameter of the GET operation. Send a JSON array, or a comma-separated string as in the query string.

Maximum array length: 100

Minimum string length: 1

channel · enum<string>[] string

Same as the channel query parameter of the GET operation. Send a JSON array, or a comma-separated string as in the query string.

Maximum array length: 50

Available options: http_async, slack, line, msteams, whatsapp, messenger, instagram, twilio_sms, zendesk, telegram, genesys, genesys_open_messaging, ai4w, kore_agent_assist, email, voice_vxml, korevg, audiocodes, genesys_audio_connector, voice_pipeline, voice_realtime, voice, voice_twilio, voice_livekit, ag_ui, a2a, sdk_websocket, web_debug, web_chat, api, http

Maximum string length: 128

traceDimensions · object

Same filter as the traceDimensions[key] query parameter, as an object of dimension name to value. Values may be strings, numbers, booleans, or an array of those. Nested objects are rejected.

Show child attributes

status · enum<string>

Same as the status query parameter of the GET operation.

Available options: active, idle, ended, completed, escalated, abandoned, archived

limit · integer · default: 100

Same as the limit query parameter of the GET operation.

Required range: 1 <= x <= 10000

offset · integer · default: 0

Same as the offset query parameter of the GET operation.

Required range: x >= 0

Response

200

application/json

Session page returned successfully (same body as the GET form).

Option 1

Option 2

success · boolean · required

Always true on a successful response.

sessions · object[] · required

The sessions on this page.

Show child attributes

total · integer · required

Total number of sessions matching your filters, across all pages.

Required range: x >= 0

offset · integer · required

The offset applied to this response.

Required range: x >= 0

limit · integer · required

The page size applied to this response.

Required range: 1 <= x <= 10000

hasMore · boolean · required

Whether more pages are available after this one.