Policy Effectiveness

Use the policy effectiveness request to get the amount of fully effective and partially effective policies (by policy category) across a specific time frame. The total effective policies across the specified time frame is also included in the response.

Endpoint

Method: POST

URL: /analytics/policy/effectiveness

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`time_range`	Array	Set the time range to get the policy effectiveness across 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`. Policy effectiveness 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`. Policy effectiveness 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
`totalEffectivePolicies`	Number	The total number of effective policies during the `time_range` specified in the request.
`policyCategoryStats`	Array	The total number of effective polices during the `time_range` specified in the request, split into policy categories. This array includes the `policyCategory` and `policyCount` parameters.
`policyCategory`	String	Specifies the policy category that the following `policyCount` 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`
`policyCount`	Number	The total number of effective polices (of the previously stated `policyCategory`) during the `time_range` specified in the request,
`policyCategoryEffectivenessStats`	Array	Shows the effectiveness of each policy category by showing how many fully effective and partially effective policies are in each policy category. The `policyCategory` and `stats` parameters are in this array.
`policyCategory`	String	Specifies the policy category that the following `stats` are regarding.
`stats`	Array	Shows the effectiveness of each policy category by showing how many fully effective and partially effective policies are in he previously stated `policyCategory`. The `status` and `policyCount` parameters are in this array.
`status`	String	Specifies the status that the following `policyCount` refers to, at the time of writing the following statuses are included for each policy category: `EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE` `EFFECTIVENESS_STATUS_FULLY_EFFECTIVE`
`policyCount`	Number	The quantity of policies 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

{
  "totalEffectivePolicies": "26",
  "policyCategoryStats": [{
    "policyCategory": "POLICY_CATEGORY_LOCKS",
    "policyCount": "2"
  }, {
    "policyCategory": "POLICY_CATEGORY_EXPORT",
    "policyCount": "2"
  }, {
    "policyCategory": "POLICY_CATEGORY_TRANSCRIPTION",
    "policyCount": "0"
  }, {
    "policyCategory": "POLICY_CATEGORY_RECORDING",
    "policyCount": "4"
  }, {
    "policyCategory": "POLICY_CATEGORY_STORAGE",
    "policyCount": "18"
  }, {
    "policyCategory": "POLICY_CATEGORY_ACCESS_CONTROL",
    "policyCount": "0"
  }],
  "policyCategoryEffectivenessStats": [{
    "policyCategory": "POLICY_CATEGORY_LOCKS",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "2"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_EXPORT",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "2"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_TRANSCRIPTION",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "0"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_RECORDING",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "4"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_STORAGE",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "18"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }, {
    "policyCategory": "POLICY_CATEGORY_ACCESS_CONTROL",
    "stats": [{
      "status": "EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE",
      "policyCount": "0"
    }, {
      "status": "EFFECTIVENESS_STATUS_FULLY_EFFECTIVE",
      "policyCount": "0"
    }]
  }]
}

In this section:

Uniphore Help Center Portal