Conversation Tracker Table

Use the conversation tracker table request to get a list of the conversations that have interacted (either Affected, Permitted Deviation, or Alerts) with a specified Policy Category, along with the relevant metadata for those conversations.

Endpoint

Method: GET

URL: /analytics/policy/conversation-tracker-table

Query Parameters

Parameter Name	Data Type	Description	Required/Optional
`page`	Integer	The conversation list can be split into pages to make it easier to use, the page parameter determines which page of your conversations you would like to get. For example a value of `0` would display the first page of your conversation list.	Optional, defaults to `0` (the first page)
`size`	Integer	As mentioned above the conversation list can be split into pages to make it easier to use, the `size` parameter determines how many conversations will be displayed per page, and therefore how many conversations you will receive in the response. For example a value of `1000` would display `1000` conversations per page, splitting your conversation list into pages of 1000.	Optional, defaults to `20`
`startDate`	Date-Time	As the list of conversations that have interacted with policies can be substantial and cover a wide time frame, use `startDate` to determine when (date and time) to show your conversations from in this request. Format: `YYYY-MM-DDT00:00:00.000` For example your conversation list could start on June 14th 2024 at 13:00 but you only want to display conversations from June 29th 2024 at 16:00, for this you would enter a value of `2024-07-29T16:00:00.000`.	Required
`endDate`	Date-Time	As the list of conversations that have interacted with policies can be substantial and cover a wide time frame, use `endDate` to determine when (date and time) to show your conversations up until in this request. Format: `YYYY-MM-DDT00:00:00.000` For example your conversation list would end at the most recent conversation that had interacted with your policies but you only want to display conversations up to June 29th 2024 at 17:00, for this you would enter a value of `2024-07-29T17:00:00.000`.	Required
`category`	String	Determine which Policy Category the conversations in the list will have interacted with, the following categories are available: `POLICY_CATEGORY_RECORDING` `POLICY_CATEGORY_STORAGE` `POLICY_CATEGORY_TRANSCRIPTION` `POLICY_CATEGORY_EXPORT` `POLICY_CATEGORY_LOCKS`	Required
`status`	String	Determine the execution status of the policy/conversation interaction, if the conversations in the list are either Affected (use `EXECUTION_STATUS_AFFECTED`), a Permitted Deviation to the policy (use `EXECUTION_STATUS_KNOWN_EXCEPTION`), or if there was an alert/issue when the policy tried to run on the conversation (use `EXECUTION_STATUS_ALERT`).	Required

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK
500	Internal Server Error

Response Parameter

The response of a successful conversation tracker table 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 conversations in the current page, these are the conversations that have interacted with the specified Policy Category, see content Sub-parameters for information on each of the parameters for each conversation.
`pageable`	Array	Information about each page of the conversation list, see pageable Sub-parameters for information on each of parameters in `pageable`.
`last`	Boolean	If the page of conversations displayed in `content` is the last page of your conversation list.
`totalPages`	Number	The total number of pages in your conversation list.
`totalElements`	Number	The total number of elements (conversations) in your conversation list, how many conversations there are.
`size`	Number	The total elements (conversations) per page, this should match the `size` specified in your request, this defaults to `20` if no `size` value is specified.
`number`	Integer	Which page of conversations 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` value is specified.
`sort`	Array	Information on the order of your conversation list, see sort Sub-parameters for more details.
`numberOfElements`	Number	The number of elements (conversations) in the current page, see `contents` for information on these conversations.
`first`	Boolean	If the page of conversations displayed in `content` is the first page of your conversation list.
`empty`	Boolean	If the conversation list currently has no data in.

content Sub-parameters

Parameter	Data Type	Description
`tenantId`	String	The ID of your tenant, the tenant the conversations displayed belong to.
`conversationID`	String	The unique ID of the conversation.
`createdTime`	Date-Time	When the conversation what captured.
`policyCategory`	String	Which policy category the conversation interacted with, this will match the `policyCategory` specified in the request.
`policyType`	String	Which type of policy the conversation interacted with.
`policyName`	String	The name of the policy that the conversation interacted with.
`status`	String	The execution status of the policy/conversation, if the conversations in the list are either Affected (`EXECUTION_STATUS_AFFECTED`), a Permitted Deviation to the policy (`EXECUTION_STATUS_KNOWN_EXCEPTION`), or if there was an alert/issue when the policy tried to run on the conversation (`EXECUTION_STATUS_ALERT`). This will match the `status` specified in the request.
`agentName`	String	The name of the agent on the conversation.
`otherParties`	Array	A list of the other parties on the conversation.

pageable Sub-parameters

Parameter	Data Type	Description
`pageNumber`	Integer	Which page of the conversation list is currently displayed in the `content` parameter.
`pageSize`	Number	The total elements (conversations) displayed in the `content` parameter per page.
`sort`	Array	Information on the order of `content`. See sort Sub-Parameters for more details.
`offset`	Integer	Which page of the conversations list 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 conversations list is displayed in pages (`true`), or all in one result (`false`).
`unpaged`	Boolean	If your conversations list is displayed as one result (`true`), or in pages (`false`).

sort Sub-parameters

Parameter	Data Type	Description
empty	Boolean	If the request specified an order to display your full conversations list/conversation list page.
sorted	Boolean	If your conversations list and conversations list page is sorted into a specific order.
unsorted	Boolean	If your conversations list and conversations list page is not sorted into a specific order.

Sample Request

/analytics/policy/conversation-tracker-table?page=0&size=1000&startDate=2024-01-01T00%3A00%3A00.000Z&endDate=2024-12-31T23%3A59%3A59.999Z&category=POLICY_CATEGORY_STORAGE&status=EXECUTION_STATUS_AFFECTED

The above request would get the first page of the conversations that have been affected by a storage policy in 2024.

Sample Response

The below example is a cut down version of a typical response, usually you would expect to see more conversations listed in the response for the request above.

{
    "content": [
        {
            "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
            "conversationId": "735e0c4f-7ffd-4553-b82e-13e968bfc2cb",
            "createdTime": "2024-11-20T15:01:22.387713332Z",
            "policyCategory": "POLICY_CATEGORY_LOCKS",
            "policyType": "POLICY_TYPE_LOCK",
            "policyName": "Lock Sales Calls",
            "status": "EXECUTION_STATUS_AFFECTED",
            "agentName": "Jane Smith",
            "otherParties": [
                {
                    "name": "Charlie Hall"
                }
            ]
        },
        {
            "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
            "conversationId": "7e4de6a4-0af8-493b-96c4-e1a5d147926c",
            "createdTime": "2024-11-20T15:01:22.370442055Z",
            "policyCategory": "POLICY_CATEGORY_LOCKS",
            "policyType": "POLICY_TYPE_LOCK",
            "policyName": "Lock Johns Calls",
            "status": "EXECUTION_STATUS_AFFECTED",
            "agentName": "Jon Doe",
            "otherParties": [
                {
                    "name": "Tom Smith"
                }
            ]
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 1000,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 2,
    "size": 1000,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 2,
    "first": true,
    "empty": false
}

In this section:

Uniphore Help Center Portal