How to query analytic events

1. Expand the Platform Management menu in the navigation panel on the left-hand side.
2. Select Monitoring.
3. Use the drop-down list on the upper-left corner to select the tenant you wish to query analytic events for.
4. Query the select tenant analytics database for events using any combination of the following query methods:
   • Use the Event ID or Request ID text boxes to query the database for events that match unique identifiers of specific events or requests you are interested in.
   • Use the Filter drop-down list to query the database for events of a specific category. You can also filter for specific types of events within each category.
   • Use the Time drop-down list to query the database for events within a given time frame. You can use any of the existing filters (e.g. Last minute, Last 5 minutes, etc.) or manually set custom FROM and TO criteria. Any filters you apply will update the list in real-time.

Make a request of the following structure to query MATTR VII analytic events:

GET /v1/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

{
    "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 and cursor 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=0QdK3jkDSPbOu1Sx9K2lM9.
  • categories : Query by event categories. Every category includes several event types. When both the categories and types parameters are provided an OR logic is applied, so the response will return all events that match either. Refer to the Events registry for an inclusive list. Example: categories=credential_compact.
  • types : Query by event types. Each event type is part of a category. When both the categories and types parameters are provided an OR logic is applied, so the response will return all events that match either. Refer to the Events registry 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.
  • clientIds : Query by client IDs. These can be retrieved from the event details. The response will include all the individual events that are part of the queried client. Example: clientIds=1f3a9c2b-7d4e-4c1f-9a6b-8d2e5f1a4b3c.
  • managementUserIds : Query by management user IDs. These can be retrieved from the event details. The response will include all the individual events that are part of the queried management user. Example: managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3.