List Events
Queries session event history with pagination. The returned structure matches the SSE frame data. Supports time window filtering 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
|
Parameter |
Type |
Default |
Description |
|
|
string |
|
Sort direction: |
|
|
string |
— |
Filter by time window, ISO 8601; the four comparison operators can be combined |
|
|
int |
20 |
Number of items per page, maximum 100 |
|
|
string |
— |
Omit on the first request; pass |
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. Message object fields are as follows:
Response fields
|
Field |
Type |
Description |
|
|
array<object> |
Array of event Message objects, sorted by |
|
|
string |
Always |
|
|
string |
Event ID, prefix |
|
|
string |
Event timestamp, ISO 8601 |
|
|
string |
|
|
|
string |
Event type, same values as SSE server push events. For details, see Subscribe to Event SSE Stream |
|
|
array<object> |
ContentBlock array, same structure as the send side |
|
|
object |
Event additional information (such as |
|
|
string | null |
Cursor for the next page; not returned or |
|
|
string |
Unique identifier for this request |