Policy View History

Use the policy view history request to view the history of your policies, how many policies are in each policy category and how effective they are on a specific day.

Endpoint

Method: POST

URL: /analytics/policy/policy-view-history

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`local_end_date`	Date-Time	The last date that you want to show the policy history results for in the format `YYYY-MM-DD`.	Required
`num_data_points`	Number	How many days prior to the `local_end_date` to show the policy history from.	Required
`time_unit`	String	The unit of time to show the policy history in, set to `TIME_UNIT_DAY`. A policy is either fully effective or partially effective for the day.	Required
`timezone`	String	The local time zone for the user sending the request, to determine when each day in the policy history (and it's effectiveness) starts and ends. Valid values for this parameter are in the TZ identifier format, for example the following values are valid, for a list of TZ identifiers please click here. `Asia/Dubai` `Asia/Singapore` `Asia/Tokyo` `Australia/Sydney` `Europe/Berlin` `Europe/London`. `US/Eastern`	Required

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK
400	Bad Request

Response Parameter

Parameter Name	Data Type	Description
`tenantId`	String	The ID of the tenant the policy history refers to.
`timezone`	Sting	The timezone used to determine when each day in the policy history starts and ends, this will match the `timezone` specified in the request.
`timeUnit`	String	The unit of time that the policy history is shown in, this will match the `timeUnit` specified in the request.
`categoryHistory`	Array	The history of the policies in your system across the time frame set in the request. Your policy history is split by policy category, each policy category is split into the following parameters in this table, `category` and `stats`.
`category`	String	The category of policy that the below `stats` refers to, at the time of writing these include: All policy categories combined: `POLICY_CATEGORY_ALL` Locks - `POLICY_CATEGORY_LOCKS` Export - `POLICY_CATEGORY_EXPORT` Transcription - `POLICY_CATEGORY_TRANSCRIPTION` Recording - `POLICY_CATEGORY_RECORDING` Storage - `POLICY_CATEGORY_STORAGE` Access Control - `POLICY_CATEGORY_ACCESS_CONTROL`
`stats`	Array	The statistics of your policy history specific to the `category` stated above, these statistics are split by date and include the following parameters: `localDate` - The date that the below parameters refer to, `totalPolicies` - The total amount of policies for this category at the end of the `localDate` specified above. `effectivePolicies` - The total amount of effective policies for this category at the end of the `localDate` specified above.

For an example response, see Sample Response.

Sample Request

{
    "local_end_date":"2024-12-17",
    "timezone":"Europe/London",
    "time_unit":"TIME_UNIT_DAY",
    "num_data_points":2
}

Sample Response

{
    "tenantId": "66dd8418-b1d1-4d47-9218-c0e29bf13170",
    "timezone": "Europe/London",
    "timeUnit": "TIME_UNIT_DAY",
    "categoryHistory": [
        {
            "category": "POLICY_CATEGORY_ALL",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "2",
                    "effectivePolicies": "2"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "9",
                    "effectivePolicies": "1"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_LOCKS",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_EXPORT",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_TRANSCRIPTION",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_RECORDING",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_STORAGE",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "2",
                    "effectivePolicies": "2"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "9",
                    "effectivePolicies": "1"
                }
            ]
        },
        {
            "category": "POLICY_CATEGORY_ACCESS_CONTROL",
            "stats": [
                {
                    "localDate": "2024-12-17",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                },
                {
                    "localDate": "2024-12-16",
                    "totalPolicies": "0",
                    "effectivePolicies": "0"
                }
            ]
        }
    ]
}

In this section:

Uniphore Help Center Portal