Skip to main content

Uniphore Customer Portal

Get Audit Log Item by ID

Use the get audit log Item by ID request to get an audit log entry matching a specified ID.

Endpoint

Method: GET

URL: /audit_log/{id}

Path Parameter

Parameter Name

Data Type

Description

Required/Optional

id

Integer

The ID of the audit log entry to get, for example 488917.

Required

Response and Error Code

Response Code

Condition

200

OK

Response Parameter

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, this should match the id specified in the path parameter.

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 asoociated 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 details provided in input and output.

result

Boolean

If the action that resulted in the audit log entry was successful (true) or unsuccessful (fasle).

Sample Response
{
    "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
}
In this section: