Conversation Execution Statistics

Use the conversation execution request to get the conversation statistics for each policy category, this includes total conversations that have been in contact by the policy category, as well as total affected, total known exceptions, and total alerts for each policy category - set a time range for the request to get the statistics for a specific time frame.

Endpoint

Method: POST

URL: /analytics/policy/conversation-execution

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`time_range`	Array	Set the time range to get the conversation execution statistics 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 statistics 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 statistics 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
`policyCategoryConvStats`	Array	Get the total affected conversations for each policy category, this array consists of the the `policyCategory` parameter, and a matching `conversationCount` parameter for each policy category.
`policyCategory`	String	Specifies the policy category that the following `conversationCount` is regarding, at the time of writing the following policy categories are shown in the response: `POLICY_CATEGORY_LOCKS` `POLICY_CATEGORY_EXPORT` `POLICY_CATEGORY_TRANSCRIPTION` `POLICY_CATEGORY_RECORDING` `POLICY_CATEGORY_STORAGE` `POLICY_CATEGORY_ACCESS_CONTROL`
`conversationCount`	Number	The quantity of conversations that have interacted with the previously stated `policyCategory` within the `time_range` specified in the request.
`policyCategoryConvExecStats`	Array	Detailed statistical information for each policy category, this array includes parameters `policyCategory` and `stats` for each policy category.
`policyCategory`	String	Specifies the policy category that the following `stats` is regarding.
`stats`	Array	Detailed statistical information for the previously stated `policyCategory` within the `time_range` specified in the request., this array includes parameters `status` and `conversationCount` for each status.
`status`	String	Specifies the status that the following `conversationCount` refers to, at the time of writing the following statuses are included for each policy category: `EXECUTION_STATUS_AFFECTED` - The policy has been successfully applied. `EXECUTION_STATUS_KNOWN_EXCEPTION` - The policy has not been applied due to a known exception, for example when a purge policy has not been applied to a conversation because the conversation is locked. `EXECUTION_STATUS_ALERT` - The policy has not been applied due to an issue.
`conversationCount`	Number	The quantity of conversations for the previously stated `status`.

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

{
  "policyCategoryConvStats": [{
    "policyCategory": "POLICY_CATEGORY_LOCKS",
    "conversationCount": "10"
  }, {
    "policyCategory": "POLICY_CATEGORY_EXPORT",
    "conversationCount": "20"
  }, {
    "policyCategory": "POLICY_CATEGORY_TRANSCRIPTION",
    "conversationCount": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_RECORDING",
    "conversationCount": "45"
  }, {
    "policyCategory": "POLICY_CATEGORY_STORAGE",
    "conversationCount": "4180"
  }, {
    "policyCategory": "POLICY_CATEGORY_ACCESS_CONTROL",
    "conversationCount": "0"
  }],
  "policyCategoryConvExecStats": [{
    "policyCategory": "POLICY_CATEGORY_LOCKS",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "10"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_EXPORT",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "20"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_TRANSCRIPTION",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_RECORDING",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "45"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_STORAGE",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "3485"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "694"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "1"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_ACCESS_CONTROL",
    "stats": [{
      "status": "EXECUTION_STATUS_AFFECTED",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_KNOWN_EXCEPTION",
      "conversationCount": "0"
    }, {
      "status": "EXECUTION_STATUS_ALERT",
      "conversationCount": "0"
    }]
  }]
}

In this section:

Uniphore Help Center Portal