Retrieve events
Returns a list of matching events from the tenant's event database.
The categories and types parameters filter based on an OR logic, whilst all other parameters use an "AND" logic. For example (categories OR types) AND requestIds AND dateFrom.
Refer to the Events registry for an inclusive list of events categories and types.
Roles
/v1/eventsIn: header
Query Parameters
Range size of returned list.
1001 <= value <= 1000Starting point for the list of entries.
Query by event IDs. These can be retrieved from event details.
Query by request IDs. These can be retrieved from event details. The response will include all the individual events that are part of the queried request.
Query by event categories. Uses an OR operation with types. Every category includes several event types. Each API endpoint details the event types it generates under the Analytic events heading. Refer to the Events registry for an inclusive list.
Query by event types. Uses an OR operation with categories. Every category includes several event types. Each API endpoint details the events it generates under the Analytic events heading. Refer to the Events registry for an inclusive list.
Query by event start date and time (inclusive), in ISO-8601 format.
date-timeQuery by event end date and time (inclusive), in ISO-8601 format.
date-timeFilter events by management user IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified management user IDs.
Special filtering values:
none: Returns events that are not assigned to any management user IDs.*: Returns events that are assigned to any management user IDs.
Filter events by client IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified client IDs.
Special filtering values:
none: Returns events that are not assigned to any client IDs.*: Returns events that are assigned to any client IDs.
Response Body
curl -X GET "https://example.vii.au01.mattr.global/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&ids=e4c387e7-3e63-40f4-9a38-062aaae9ee50&requestIds=e4c387e7-3e63-40f4-9a38-062aaae9ee50&categories=credential_compact&types=CREDENTIAL_COMPACT_SIGN_START&dateFrom=2023-06-01T02%3A45%3A44.087Z&dateTo=2023-06-30T23%3A59%3A59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf"{
"data": [
{
"id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",
"type": "CREDENTIAL_COMPACT_SIGN_START",
"timestamp": "2023-06-01T02:45:44.087Z",
"category": "credential-compact",
"requestId": "4SO6JZz3sPYLjOQvxIVHr5",
"managementUserId": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3",
"clientId": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf",
"metadata": {},
"data": {}
}
],
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}"Unauthorized"How would you rate this page?