List Events

Updated at:

Queries session event history with pagination. The returned structure matches the SSE frame data. Supports filtering by event type, time window, and sorting.

Prerequisites

A session must already be created. For details, see Create Session. {session_id} is in the format sesn_xxx....

Endpoint

GET /sessions/{session_id}/events

The returned structure matches the SSE frame data. For details on event envelope fields, see the Event envelope section in Subscribe to Event SSE Stream.

Query parameters

ParameterTypeDefaultDescription
typesstring—Filter by event type; can be repeated. Example: ?types=message&types=tool_approval_request. Use types=error to re-fetch runtime errors
orderstringascSort direction: asc (ascending) / desc (descending)
created_at[gt] / [gte] / [lt] / [lte]string—Filter by time window, ISO 8601; the four comparison operators can be combined
limitint20Number of items per page, maximum 100
pagestring—Omit on the first request; pass next_page from the previous response for subsequent requests

Request example

curl "$AGENTSTUDIO_URL/sessions/sesn_xxx/events?order=asc&limit=100" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
for event in client.sessions.events.list(
    "sesn_xxx",
    limit=100,
    order="asc",
):
    print(event.type, event.created_at)
CursorPage<SessionEvent> events = client.sessions().events().list("sesn_xxx",
    SessionEventListParam.builder()
        .limit(100)
        .order("asc")
        .build());
for (SessionEvent ev : events.getData()) {
    System.out.println("[" + ev.getType() + "] " + ev.getCreatedAt());
}

Response

Returns data (an array of event Message objects with the same structure as the SSE frame data field; for details, see Subscribe to Event SSE Stream), next_page (cursor for the next page; not returned or null when there is no more data), and request_id. type=error is a separate branch: error details are in the top-level error object of the Message (error.code / error.message), not in content[].data. Message object fields are as follows:

Response fields

FieldTypeDescription
dataarray<object>Array of event Message objects, sorted by order
data[].objectstringAlways message
data[].idstringEvent ID, prefix msg_ or out_
data[].created_atstringEvent timestamp, ISO 8601
data[].statusstringAlways completed
data[].rolestringuser / assistant / tool
data[].typestringEvent type, same values as SSE server push events. For details, see Subscribe to Event SSE Stream
data[].contentarray<object>ContentBlock array, same structure as the send side
data[].is_errorboolOnly on tool output events (tool_call_output / mcp_call_output), written at the Message top level: true means the tool execution failed or was interrupted/rejected; in that case data is still a ToolCallOutput / McpCallOutput containing at least call_id and output
data[].metadataobjectEvent additional information (such as thread_id, call_id, etc.)
next_pagestring / nullCursor for the next page; not returned or null when there is no more data
request_idstringUnique identifier for this request