How to query for analytic events
You can make an API request to retrieve MATTR VII analytic events.
Request
Make a request of the following structure to query MATTR VII analytic events:
HTTP
GET /v1/analytics/events?requestIds=0QdK3jkDSPbOu1Sx9K2lM9
This request queries the tenant for all analytic events that match the provided requestIds
. You
can append any of the available query parameters to your request.
Response
JSON
{
"data": [
{
"id": "f570ff36-9035-439c-8e25-dc0cd67b4b4a",
"type": "DID_RETRIEVE_LIST_SUCCESS",
"timestamp": "2023-08-20T22:32:59.151Z",
"category": "did",
"requestId": "0QdK3jkDSPbOu1Sx9K2lM9",
"metadata": {
"nextCursor": "Y3JlYXRlZEF0PTIwMjMtMDctMzFUMDAlM0EyMSUzQTMwLjUyN1omaWQ9Yzk3NmQ0YmEtNjE2OC00MTkyLWE4YjAtNjE3NzNiZmNhM2M3",
"entriesCount": 8
},
"data": null
},
{
"id": "d7a38f9a-374f-4e4d-9cc0-42149d61540a",
"type": "DID_RETRIEVE_LIST_START",
"timestamp": "2023-08-20T22:32:59.148Z",
"category": "did",
"requestId": "0QdK3jkDSPbOu1Sx9K2lM9",
"metadata": {
"limit": 100
},
"data": null
}
],
"nextCursor": "dGltZXN0YW1wPTIwMjMtMDgtMjBUMjIlM0EzMiUzQTU5LjE0OFomaWQ9ZDdhMzhmOWEtMzc0Zi00ZTRkLTljYzAtNDIxNDlkNjE1NDBh"
}
data
: This array includes all the events that matched the query parameters. The example response includes two events that were part of a DID retrieval request - one for the start of the request, and one for the successful completion. Each event includes the following parameters:id
: Event identifier.type
: Event type.timestamp
: Event creation date and time.category
: Event category.requestId
: Request identifier.metadata
: Available metadata will vary based on Event type and logging level.data
: Available data will vary based on Event type and logging level.
nextCursor
: This element is used for pagination the response. Refer to our API Reference for more information.
Query parameters
- All parameters support comma separated lists.
- All query parameters are optional. If no parameters are provided, the most recent 100 events are returned by default.
- Use the
limit
andcursor
parameters in your request to control the response pagination. - The following request parameters are available:
ids
: Query by event IDs. These can be retrieved from the event details. Example:ids=e4c387e7-3e63-40f4-9a38-062aaae9ee50
.requestIds
: Query by request IDs. These can be retrieved from the event details. The response will include all the individual events that are part of the queried request. Example:requestIds=e4c387e7-3e63-40f4-9a38-062aaae9ee50
.categories
: Query by event categories. Every category includes several eventtypes
. When both the categories and types parameters are provided anOR
logic is applied, so the response will return all events that match either. Refer to the Events registry (opens in a new tab) for an inclusive list. Example:categories=credential_compact
.types
: Query by event types. Each event type is part of acategory
. When both the categories and types parameters are provided anOR
logic is applied, so the response will return all events that match either. Refer to the Events registry (opens in a new tab) for an inclusive list. The API Reference also details event types that are generated by specific endpoints. Example:categories=CREDENTIAL_COMPACT_SIGN_START
.dateFrom
/dateTo
: Query by event start and/or end date and time, in ISO-8601 format. Examples:dateFrom=2023-06-01T02:45:44.087Z
/dateTo=2023-06-30T23:59:59.999Z
.