Get Audit Log

Use the get audit log request to get a complete list of your system audit logs.

Endpoint

Method: GET

URL: /audit_log/

Query Parameters

Parameter Name	Data Type	Description	Required/Optional
`page`	Integer	The audit log can be split into pages to make it easier to use, the `page` parameter determines which page of your audit log you would like to get. For example a value of `0` would display the first page of your audit log.	Optional, defaults to `0` (the first page)
`size`	Integer	As mentioned above the audit log can be split into pages to make it easier to use, the `size` parameter determines how many audit log entries will be displayed per page, and therefore how many audit log entries you will receive in the response. For example a value of `20` would display 20 audit log entries per page, splitting your audit log into pages of 20.	Optional, defaults to `20`.
`sort`	String	Sort your results by specifying what parameter in the response to sort by, and then what order to sort them in, this is in the form `parameter,order`. See content Sub-parameters for a list of valid parameters to sort by. Valid orders: descending (`desc`) or ascending (`asc`). For example setting `sort` to `createdDate,desc` will sort the audit log using the `createdDate` description for each audit log entry, and order them in a descending order.	Optional
`startDate`	Date-Time	As your full audit log can be substantial and cover a wide timeframe, use `startDate` to determine when (date and time) to show your audit log from in this request. Format: `YYYY-MM-DDT00:00:00.000` For example your full audit log could start on June 14th 2024 at 13:00 but you only want to display audit log entries from June 29th 2024 at 16:00, for this you would enter a value of `2024-07-29T16:00:00.000`.	Optional
`endDate`	Date-Time	As your full audit log can be substantial and cover a wide timeframe, use `endDate` to determine when (date and time) to show your audit log up until in this request. Format: `YYYY-MM-DDT00:00:00.000` For example your full audit log would end at the most recent audit log entry but you only want to display audit log entries up to June 29th 2024 at 16:00, for this you would enter a value of `2024-07-29T16:00:00.000`.	Optional
`searchText`	String	Enter text to filter the audit log by, the audit log will only display audit log entries that contain the specified text here.	Optional
`category`	String	Filter your audit log by `activityType`. Enter an audit log category to only display audit log entries with a matching `activityType`, use the get audit log categories request to view audit log categories in your system.	Optional
`success`	Boolean	Filter your audit log by whether or not the action that resulting in the audit log entry was successful (`true`) or unsuccessful (`false`).	Optional

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

The response of a successful get audit log request will provide the parameters listed in the table below, the content, pageable, and sort array parameters have sub-parameters that are covered in more detail in their own table.

For an example response, see Sample Response.

Parameter Name	Data Type	Description
`content`	Array	The log entries in the current page, these are the details for each system action, see content Sub-parameters for information on each of the parameters for each log entry.
`pageable`	Array	Information about each page in your audit log, see pageable Sub-parameters for information on each of parameters in `pageable`.
`last`	Boolean	If the page of log entries displayed in `content` is the last page of your audit log.
`totalPages`	Number	The total number of pages in your audit log.
`totalElements`	Number	The total number of elements in your audit log, how many log entries there are.
`size`	Number	The total elements (log entries) per page, this should match the `size` specified in your request, this defaults to `20` if no `size` is specified.
`number`	Integer	Which page of log entries is currently displayed in the `content` parameter, this should match the `page` specified in your request, this defaults to `0` (the first page) if no `page` is specified.
`sort`	Array	Information on the order of your full audit log, see sort Sub-parameters for more details, this should match the `sort` specified in your request.
`numberOfElements`	Number	The number of elements (log entries) in the current page, see `contents` for these log entries.
`first`	Boolean	If the page of log entries displayed in `content` is the first page of your audit log.
`empty`	Boolean	If the audit log currently has no data in.

content sub-parameters

Parameter	Data Type	Description
`tenantId`	String	The ID of your tenant, the tenant the audit log entry displayed belongs to.
`CreatedDate`	Number	The date that the log entry was created in the format `MM-DD-YYYY HH:MM:SS`.
`UpdatedDate`	Number	The date that the log entry was last updated in the format `MM-DD-YYYY HH:MM:SS`.
`source`	String	Placeholder for upcoming enhancement, this will show as `null` until the enhancement is released.
`version`	String	Placeholder for upcoming enhancement, this will show as `null` until the enhancement is released.
`id`	Integer	The ID of the specific audit log entry.
`emailId`	String	The email of the user who's activity in the system generated the log entry if applicable.
`fullName`	String	The full name of the user who's activity in the system generated the log entry if applicable.
`businessUnit`	String	The business unit associated with the user who's activity in the system generated the log entry if applicable.
`agentId`	Integer	The agent ID of the user who's activity in the system generated the log entry if applicable.
`activityType`	String	The type of activity in the system that generated the log entry, for example `"Search And Replay"`. To get a list of possible activity types, use the get all audit categories request.
`details`	Array	Technical details about the log entry, typically these details include the following: `output` - the result/outcome of the system activity. `input` - the technical parameters that were used to generate and action the system request. `actionType` - the type of system action associated with the log entry, this is more specific than `activityType`, for example `"Search For Completed Calls"`. `ActionDescription` - an easy to read description of the system action, allowing for a more immediate understanding of the log than the technical details provided in `input` and `output`.
`result`	Boolean	If the action that resulted in the audit log entry was successful (`true`) or unsuccessful (`fasle`).

pageable Sub-parameters

Parameter Name	Data Type	Description
`pageNumber`	Integer	Which page of log entries is currently displayed in the `content` parameter.
`pageSize`	Number	The total elements (log entries) displayed in the `content` parameter per page.
`sort`	Array	Information on the order of `content`, this should match the `sort` specified in the request. See sort Sub-parameters for more details.
`offset`	Integer	Which page of audit log entries is displayed in the `content` parameter, starting at `0` for the first page, for a total number of pages see `totalpages`.
`paged`	Boolean	If your audit log is displayed in pages (`true`), or all in one result (`false`).
`unpaged`	Boolean	If your audit log is displayed as one result (`true`), or in pages (`false`).

sort Sub-parameters

Parameter Name	Data Type	Description
`empty`	Boolean	If the request specified an order to display your full audit log/audit log page.
`sorted`	Boolean	If your audit log and audit log page is sorted into a specific order.
`unsorted`	Boolean	If your audit log and audit log page is not sorted into a specific order.

Sample Request

/audit_log?page=0&size=20&sort=createdDate,desc&startDate=2024-07-24T23:00:00.000&endDate=2024-07-26T22:00:00.000&success=true

Sample Response

Note

The below sample response has been shortened for document formatting purposes, where content only shows one audit log entry rather than the 20 specified in numberOfElements.

  {
    "content": [
        {
            "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
            "createdDate": "04-05-2024 09:38:09",
            "updatedDate": "04-05-2024 09:38:09",
            "source": null,
            "version": null,
            "id": 833032,
            "emailId": "john.doe@domain.com",
            "fullName": "John Doe",
            "businessUnit": null,
            "agentId": 0,
            "activityType": "Search And Replay",
            "details": {
                "output": "{live_calls=(Count: 32), next_page_token=, total_count=32}",
                "input": "{request={pageSize=500}}",
                "actionType": "Search For Live Calls",
                "actionDescription": "Live Conversations viewable by user per his access control were fetched successfully with the filter provided."
            },
            "result": true
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 114792,
    "totalElements": 2295829,
    "size": 20,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 20,
    "first": true,
    "empty": false
}

In this section:

Uniphore Customer Portal