Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Sessions

List events in agent session

Lists all events in a specific agent session, with optional pagination.

get/v2/agents/{agent_key}/sessions/{session_key}/events

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique identifier of the agent.

session_keystring required

A unique key that identifies an agent session.

Example:customer_support_chat

The unique key of the session to list events for.

Query parameters

limitinteger

The maximum number of events to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

include_hiddenboolean

Include hidden events (compacted or manually hidden) in the response. Defaults to false.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of events in the session.

Example response

{
  "events": [
    {
      "id": "aev_user_001",
      "session_key": "customer_support_chat",
      "created_at": "2024-01-15T10:35:00Z",
      "messages": [
        {
          "type": "text",
          "content": "I need help with my widget installation"
        }
      ]
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}