List Event using Signals ID (Cursor)
This endpoint allows you to list events for a signal session using cursor pagination and optional filters. Sorted by createdAt ascending.
GET {{baseurl}}/v2/api/signals/:signalId/events/cursor
Headers
Name
Type
Description
token*
String
API secret token
Parameter
Field
Type
Description
signalId
String
Signal unique identifier (ebs_ prefix accepted)
limit
Number
Page size
Default value: 20
startAfter
String
Document id cursor for the next page
endingBefore
String
Document id cursor for the previous page
eventType
String
Comma-separated event types (session_start, session_end, custom)
startDate
String
Date-only YYYY-MM-DD (inclusive)
endDate
String
Date-only YYYY-MM-DD (inclusive)
{
"success": true,
"statusCode": 200,
"message": "Events retrieved successfully!",
"data": {
"docs": [],
"nextCursor": "event_123",
"prevCursor": null,
"hasNextPage": true,
"hasPrevPage": false,
"totalDocs": 7
},
"links": []
}HTTP/1.1 404 NotFound
{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}Last updated
Was this helpful?
