Conversation Execution Summary

Use the conversation-execution-suppl request to get a summary of the conversation statistics across your policies, including information for all policies combined as well as individually, statistics include: total conversations, total affected conversations, total conversations where the policy has not been applied, total conversations where the policy has not been applied due to a known exception, and total conversations where the policy has not been applied due to an issue - set a time range for the request to get the statistics for a specific time frame.

Endpoint

Method: POST

URL: /analytics/v2/policy/conversation-execution-suppl

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`time_range`	Array	Set the time range to get the conversation execution summary for a specific time frame, this array consists of a `start_time` and an `end_time`.	Required
`start_time`	Date Time	Set the earlier time frame parameter for the `time_range`. Conversation execution summary before the parameter value will not be included in the response, in the format `YYYY-MM-DDTHH:MM:SS:000Z`, for example `2024-01-01T00:00:00.000Z` would be the start of 2024.	Required
`end_time`	Date Time	Set the later time frame parameter for the `time_range`. Conversation execution summary after the parameter value will not be included in the response, in the format `YYYY-MM-DDTHH:MM:SS:000Z`, for example `2024-12-31T23:59:59.999Z` would be the end of 2024.	Required

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

Parameter Name	Data Type	Description
`conversationStats`	Array	A summary of the conversation statistics across your policies, including information for all policies combined as well as individually.
`policyCategory`	String	Specifies the policy category that the subsequent parameters are regarding, at the time of writing the following policy categories are shown in the response: `POLICY_CATEGORY_ALL` - This is a total for all of the policy categories combined. `POLICY_CATEGORY_LOCKS` - Locks Policies `POLICY_CATEGORY_EXPORT` - Export Policies `POLICY_CATEGORY_TRANSCRIPTION` - Transcription Policies `POLICY_CATEGORY_RECORDING` - Recording Policies `POLICY_CATEGORY_STORAGE` - Storage Policies `POLICY_CATEGORY_ACCESS_CONTROL` - Access Control Policies
`conversationsTotal`	Number	The quantity of conversations that have interacted with the previously stated `policyCategory` within the `time_range` specified in the request.
`conversationsNotApplied`	Number	The quantity of conversations that have interacted with the previously stated `policyCategory` within the `time_range` specified in the request but have not been affected by it.
`conversationsAffected`	Number	The quantity of conversations that have been affected by a policy from the previously stated `policyCategory` within the `time_range` specified in the request.
`conversationsKnownException`	Number	The quantity of conversations that have interacted with the previously stated `policyCategory` within the `time_range` specified in the request but have not been affected by it due to a known exception, for example when a purge policy has not been applied to a conversation because the conversation is locked.
`conversationsAlert`	Number	The quantity of conversations that have interacted with the previously stated `policyCategory` within the `time_range` specified in the request but have not been affected by it due to an issue.

For an example response, see Sample Response.

Sample Request

{
    "time_range":{
        "start_time":"2024-01-01T00:00:00.000Z",
        "end_time":"2024-12-31T23:59:59.999Z"
    }
}

Sample Response

{
  "conversationStats": [{
    "policyCategory": "POLICY_CATEGORY_ALL",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "695",
    "conversationsAffected": "3560",
    "conversationsKnownException": "694",
    "conversationsAlert": "1"
  }, {
    "policyCategory": "POLICY_CATEGORY_LOCKS",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "0",
    "conversationsAffected": "10",
    "conversationsKnownException": "0",
    "conversationsAlert": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_EXPORT",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "0",
    "conversationsAffected": "20",
    "conversationsKnownException": "0",
    "conversationsAlert": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_TRANSCRIPTION",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "0",
    "conversationsAffected": "0",
    "conversationsKnownException": "0",
    "conversationsAlert": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_RECORDING",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "0",
    "conversationsAffected": "45",
    "conversationsKnownException": "0",
    "conversationsAlert": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_STORAGE",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "695",
    "conversationsAffected": "3485",
    "conversationsKnownException": "694",
    "conversationsAlert": "1"
  }, {
    "policyCategory": "POLICY_CATEGORY_ACCESS_CONTROL",
    "conversationsTotal": "1942",
    "conversationsNotApplied": "0",
    "conversationsAffected": "0",
    "conversationsKnownException": "0",
    "conversationsAlert": "0"
  }]
}

In this section:

Uniphore Help Center Portal