Learn

Analytics

Specifies paths and operations for retrieving platform analytics data.

Retrieve eventsDeprecated

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: ["admin","auditor"]
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
ids
Array of strings

Query by event IDs. These can be retrieved from event details.

Example: ids=e4c387e7-3e63-40f4-9a38-062aaae9ee50
requestIds
Array of strings

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.

Example: requestIds=e4c387e7-3e63-40f4-9a38-062aaae9ee50
categories
Array of strings

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.

Example: categories=credential_compact
types
Array of strings

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.

Example: types=CREDENTIAL_COMPACT_SIGN_START
dateFrom
string <date-time>

Query by event start date and time (inclusive), in ISO-8601 format.

Example: dateFrom=2023-06-01T02:45:44.087Z
dateTo
string <date-time>

Query by event end date and time (inclusive), in ISO-8601 format.

Example: dateTo=2023-06-30T23:59:59.999Z
Array of strings or string

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.
Array of strings or 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.
Responses
200

A list of events

400

Bad Request. The request was malformed or missing required parameters.

401

Unauthorized. The client is not recognized by authorization server.

403

Forbidden. The client is recognized by authorization server but is not allowed to access this resource.

500

Internal Server Error. An unexpected error occurred.

get/v1/analytics/events
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
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:  ["admin","auditor"]
SecuritybearerAuth 
Request 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of returned list.


 
 Example:  limit=2
cursor
string
Starting point for the list of entries.


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
ids
Array of strings
Query by event IDs. These can be retrieved from event details.


 
 Example:  ids=e4c387e7-3e63-40f4-9a38-062aaae9ee50
requestIds
Array of strings
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.


 
 Example:  requestIds=e4c387e7-3e63-40f4-9a38-062aaae9ee50
categories
Array of strings
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.


 
 Example:  categories=credential_compact
types
Array of strings
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.


 
 Example:  types=CREDENTIAL_COMPACT_SIGN_START
dateFrom
string <date-time> 
Query by event start date and time (inclusive), in ISO-8601 format.


 
 Example:  dateFrom=2023-06-01T02:45:44.087Z
dateTo
string <date-time> 
Query by event end date and time (inclusive), in ISO-8601 format.


 
 Example:  dateTo=2023-06-30T23:59:59.999Z
Array of strings or string
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.
    • 



 
Array of strings or 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.
    • 



 
Responses 
200
A list of events


400
Bad Request. The request was malformed or missing required parameters.


401
Unauthorized. The client is not recognized by authorization server.


403
Forbidden. The client is recognized by authorization server but is not allowed to access this resource.


500
Internal Server Error. An unexpected error occurred.


get/v1/events
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
➔ Next to Messaging