Policy View KPI Metrics

Use the policy view kpi metrics request to get key metrics about your policies over a given time frame, including how many policies there are, how many policies were effective, how many where created, and how many policies were disabled, these metrics are provided for all policies categories combined as well as by policy category.

Endpoint

Method: POST

URL: /analytics/policy/policy-view-kpi-metrics

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`time_range`	Array	Set the time range that you would like to receive the policy metrics for, this array consists of a `start_time` and an `end_time`.	Required
`start_time`	Date-Time	Set the earlier time frame for the `time_range` to receive the policy metrics for. Policy metrics before the parameter value will not be included in the response, in the format `YYYY-MM-DDT00:00:00.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 for the `time_range` to receive the policy metrics for. Policy metrics after the parameter value will not be included in the response, in the format `YYYY-MM-DDT00:00:00.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
`categoryKpiMetrics`	Array	Your policy metrics for the `time_range` specified in the request, these metrics are split into each policy category as well as all policy categories combined, each category uses the following parameters in this table.
`category`	String	The policy category that the following metrics refer to, at the time of writing these include: `POLICY_CATEGORY_ALL` `POLICY_CATEGORY_LOCKS` `POLICY_CATEGORY_EXPORT` `POLICY_CATEGORY_TRANSCRIPTION` `POLICY_CATEGORY_RECORDING` `POLICY_CATEGORY_STORAGE` `POLICY_CATEGORY_ACCESS_CONTROL`
`totalPolicies`	Number	The total amount of policies in the above policy `category` during the specified `time_range`.
`effectivePolicies`	Number	The total amount of fully effective policies in the above policy `category` during the specified `time_range`.
`newPolicies`	Number	The total amount of new policies created for the above policy `category` during the specified `time_range`.
`disabledPolicies`	Number	The total amount of disabled policies in the above policy `category` during the specified `time_range`.

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

{
    "categoryKpiMetrics": [
        {
            "category": "POLICY_CATEGORY_ALL",
            "totalPolicies": "16",
            "effectivePolicies": "5",
            "newPolicies": "16",
            "disabledPolicies": "11"
        },
        {
            "category": "POLICY_CATEGORY_LOCKS",
            "totalPolicies": "2",
            "effectivePolicies": "2",
            "newPolicies": "2",
            "disabledPolicies": "0"
        },
        {
            "category": "POLICY_CATEGORY_EXPORT",
            "totalPolicies": "2",
            "effectivePolicies": "0",
            "newPolicies": "2",
            "disabledPolicies": "2"
        },
        {
            "category": "POLICY_CATEGORY_TRANSCRIPTION",
            "totalPolicies": "0",
            "effectivePolicies": "0",
            "newPolicies": "0",
            "disabledPolicies": "0"
        },
        {
            "category": "POLICY_CATEGORY_RECORDING",
            "totalPolicies": "4",
            "effectivePolicies": "1",
            "newPolicies": "4",
            "disabledPolicies": "3"
        },
        {
            "category": "POLICY_CATEGORY_STORAGE",
            "totalPolicies": "8",
            "effectivePolicies": "2",
            "newPolicies": "8",
            "disabledPolicies": "6"
        },
        {
            "category": "POLICY_CATEGORY_ACCESS_CONTROL",
            "totalPolicies": "0",
            "effectivePolicies": "0",
            "newPolicies": "0",
            "disabledPolicies": "0"
        }
    ]
}

In this section:

Uniphore Help Center Portal