List API

Introduction

This API gets a list of all sessions within certain parameters.

URL

api/audit-trail/list

Method

GET

Required URL Parameters

Customer-id (string)

Data Parameters

The following describe required and optional data parameters.

Name	Type	Description
apiKey	string	The API key for the provided environment.
firstEventTimestamp	string	the timestamp of the first event. needs to be sent in RFC 3339 (ISO 8601) compliant format,
lastEventTimestamp	string	the timestamp of the last event. needs to be sent in RFC 3339 (ISO 8601) compliant format,

Sample Call

JSON

{
"apiKey": "1234",
"firstEventTimestamp": "2022-07-01",
"lastEventTimestamp": "2023-08-21T00:00:00+00:00"
}

Success Response

Success or failure is determined by the request’s HTTP status.
200 indicates success. Any other status is erroneous. A successful request will return an array of values as follows:

JSON

[
  {
    "master_rid": <string>,
    "request_id": <string>
    "first_event_timestamp": <string>,
    "last_event_timestamp": <string>
  }
]