Skip to main content

Uniphore Help Center Portal

Policy View Table

Use the policy view table request to view a list of the policies for a specific policy category over a specific time range, for a specific level of effectiveness.

Endpoint

Method: POST

URL: /analytics/policy/policy-view-table

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

time_range

Array

Set the time range for the policies to view using the start_time and end_time following parameters, in the format YYYY-MM-DDT00:00:00.000Z.

For example use a start_time value of 2024-01-01T00:00:00.000Z and an end_time value of 2024-12-31T23:59:59.999Z to view information on policies for the year 2024.

Required

category

String

Determine which policy category to view the policies for, valid values include:

  • POLICY_CATEGORY_LOCKS

  • POLICY_CATEGORY_EXPORT

  • POLICY_CATEGORY_TRANSCRIPTION

  • POLICY_CATEGORY_RECORDING

  • POLICY_CATEGORY_STORAGE

Required

effective_status

String

Determine the effectiveness level of the policies to view in the response, valid values include:

  • EFFECTIVENESS_STATUS_FULLY_EFFECTIVE

  • EFFECTIVENESS_STATUS_PARTIALLY_EFFECTIVE

Required

For an example request, see Sample Request.

Response and Error Code

Response Code

Condition

200

OK

Response Parameter

Parameter Name

Data Type

Description

tenantId

String

The ID of the tenant that the policies belong to.

records

Array

A list of the policies that match the specified category, effectiveness level and time frame, each with the following parameters in this table.

policyName

String

The name of the policy.

createdBy

String

The user that created the policy.

createdDate

Date-Time

The date and time that the policy was created.

activeTimeRanges

Array

The date-time range that the policy was active for within the time_range specified in the request, detailed using the following parameters:

  • startTime

  • endTime

The values for the above startTime and endTime will match the values specified in the request if the policy was active for the entire time_range specified in the request.

For an example response, see Sample Response.

Sample Request
{
    "time_range":{
        "start_time":"2025-01-28T11:02:58.700Z",
        "end_time":"2025-02-04T11:02:58.699Z"
    },
    "category":"POLICY_CATEGORY_STORAGE",
    "effective_status":"EFFECTIVENESS_STATUS_FULLY_EFFECTIVE"
}
Sample Response
{
    "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
    "records": [
        {
            "policyName": "Delete 5yr Outgoing",
            "createdBy": "Matthew Lee",
            "createdDate": "2024-12-16T14:51:34.518288605Z",
            "activeTimeRanges": [
                {
                    "startTime": "2025-01-28T11:02:58.700Z",
                    "endTime": "2025-02-04T11:02:58.699Z"
                }
            ]
        },
        {
            "policyName": "Move Support Audio at 90 Days",
            "createdBy": "Matthew Lee",
            "createdDate": "2024-11-19T09:14:17.789650054Z",
            "activeTimeRanges": [
                {
                    "startTime": "2025-01-28T11:02:58.700Z",
                    "endTime": "2025-02-04T11:02:58.699Z"
                }
            ]
        }
    ]
}
In this section: