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.
Refer to How to query analytic events for guidance on ordering, paging and filtering results.
Roles
bearerAuthAuthorizationBearer <token>limit?numberRange size of returned list.
1 <= value <= 1000100cursor?stringStarting point for the list of entries.
order?stringDirection to order the results in by event timestamp. asc returns oldest first, desc returns newest first.
Keep order unchanged while paging with a cursor.
"desc""asc""desc"ids?array<>Query by event IDs. These can be retrieved from event details.
requestIds?array<>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.
categories?array<>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.
types?array<>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.
dateFrom?stringQuery by event start date and time (inclusive), in ISO-8601 format. Filters on the event timestamp.
date-timedateTo?stringQuery by event end date and time (inclusive), in ISO-8601 format. Filters on the event timestamp.
date-timemanagementUserIds?array<>|Filter 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.
clientIds?array<string>|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.
applicationIds?array<>Filter events by application IDs.
applicationInstanceIds?array<>Filter events by application instance IDs. An application instance is a specific installation of an application on a device.
sessionIds?array<>Filter events by the top-level sessionId field. Does not match a sessionId value inside the event data.
A list of events
application/json- response
data?array<>nextCursor?stringStarting point for next cursor to use in a page.
curl -X GET 'https://example.vii.au01.mattr.global/v1/events'{ "data": [ { "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c", "type": "CREDENTIAL_COMPACT_SIGN_START", "timestamp": "2023-06-01T02:45:44.087Z", "createdAt": "2023-06-01T02:47:11.442Z", "category": "credential-compact", "requestId": "4SO6JZz3sPYLjOQvxIVHr5", "requestIp": "192.0.2.1", "managementUserId": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3", "clientId": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", "applicationId": "7d2e4c81-5b3f-4a19-8e6d-0f1a2b3c4d5e", "applicationInstanceId": "c3a9f1d7-8b24-4e05-9f3a-6d7c8e9f0a1b", "sessionId": "b4e1c9a7-2f61-4d08-9a3e-7c5b1f0e2d94", "metadata": {}, "data": {} } ], "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}How would you rate this page?