List event log entries

Returns a page of event log entries. Events can occur either system or user initiated. In case an event is user initiated the event context contains information on the user that triggered it and the associated HTTP request is captured.

Request

query Parameters

sortDirection	string The direction the returned data will be sorted by. Enum: "Asc" "Desc"
type	Array of strings If set, only returns events with the specified type. More than 1 type can be specified. Items Enum: "System" "Request" "Legacy"
includeFailedRequests	boolean If set to `true`, also includes failed request events (these are filtered out by default). Note that not all failed requests can be captured or assigned to your organization, depending on the nature of the failure.
entityId	Array of strings <uuid> If set, only returns events related to the specified identifier. For example, to filter on events for a given provider, set this parameter to the identifier of that provider. More than 1 entity identifier can be specified.
category	Array of strings If set, only returns events related to the specified category. More than 1 category can be specified. Items Enum: "Verifications" "ProviderInfo" "ProviderManagement" "Organization" "Integrations" "Groups" "ProviderProfile" "Beta" "Mpd" "Console" "FacilityManagement" "FacilityInfo"
subcategory	Array of strings If set, only returns events related to the specified subcategory. The subcategories differ per `category`. More than 1 subcategory can be specified.
before	string <date-time> If set, only returns events from before this date.
beforeInclusive	boolean If set to `true`, will include events created exactly at `before` date and time too.
after	string <date-time> If set, only returns events from after this date.
afterInclusive	boolean If set to `true`, will include events created exactly at `after` date and time too.
correlationId	string <uuid> If set, only returns events related to the specified correlation identifier.
sortedBy	string The property by which the returned data will be sorted. Enum: "Timestamp" "Type"
	object If set, the properties and directions the returned data will be sorted by.
offset	integer <int32> Deprecated The offset for the page to start.
cursor	string The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.
count	integer <int32> The number of items to include in a single page.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/log/events

Response samples

application/json

{"previousCursor": "string",
"nextCursor": "string",
"nextOffset": 0,
"pageSize": 20,
"count": 1,
"totalCount": 1,
"items": [{"id": "50587ba5-ed48-4430-b9fd-6b4518979a84",
"timestamp": "2021-10-04T14:21:45.6433130Z",
"type": "Request",
"messageTemplate": "Viewed event log",
"context": {"user": {"id": "40b87c94-e279-4412-933b-6dc87980bc31",
"role": "admin",
"email": "john.doe@verifiable.com"
},
"request": {"route": "log/events",
"method": "GET",
"operation": "ListEventLogEntries",
"timeTaken": 6,
"userAgent": "PostmanRuntime/7.28.4",
"queryString": "includeReadEvents=true",
"userTokenId": "defbffb0-861e-4b4b-b899-b9452ef0089b",
"responseType": "application/json; charset=utf-8",
"routeTemplate": "log/events",
"userIpAddress": "0.0.0.1",
"responseStatusCode": 200
},
"relatedEntities": [ ]
}
}
],
"sortedBy": "Timestamp",
"sortDirection": "Desc",
"sort": {"Timestamp": "Desc"
}
}