Gets DPS Policy stats for a given BOC.

get https://{api-base-url}/datapoints/v1/cluster/{cluster_id}/sdwan_policy/policy_stats/{policy_name}

DPS Policy stats for a given BOC.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

dps_policy_stats_data

array of objects

DPS Policy Stats Data

dps_policy_stats_data

object

dps_overall_policy_session_stats_data

array of arrays of objects

dps_overall_policy_session_stats_data

array of objects

object

timestamp

integer

required

Epoch Timestamp in milliseconds

session_count

integer

required

Session count of the DPS Policy for a given BOC

dps_policy_status_data

array of objects

Dps Policy Status Internal Data

dps_policy_status_data

object

timestamp

integer

required

Epoch Timestamp in milliseconds

policy_status

string

required

Status of the DPS Policy for a given BOC, Could either be Compliant or Non Compliant

policy_name

string

required

Name of the DPS Policy for a given BOC

interval

integer

required

Sampling window in seconds

policy_name

string

required

Name of the DPS Policy for a given BOC

dps_individual_uplink_policy_session_stats_data

array of arrays of objects

dps_individual_uplink_policy_session_stats_data

array of objects

object

uplink_name

string

required

Name of the Uplink configured for DPS Policy for a given BOC

uplink_policy_session_stats_data

array of objects

List of Dps Policies Session Stats Internal Data

uplink_policy_session_stats_data

object

timestamp

integer

required

Epoch Timestamp in milliseconds

session_count

integer

required

Session count of the DPS Policy for a given BOC

dps_individual_uplink_policy_stats_data

array of arrays of objects

dps_individual_uplink_policy_stats_data

array of objects

object

uplink_name

string

required

Name of the Uplink configured for DPS Policy for a given BOC

uplink_policy_stats_data

array of objects

List of Dps Policies Stats Internal Data

uplink_policy_stats_data

object

timestamp

integer

required

Epoch Timestamp in milliseconds

individual_uplink_probe_result

array of objects

List of Dps Policies Individual Uplinks Probes Stats Internal Data

individual_uplink_probe_result

object

path_steering_value

number

required

DPS Value, For a particular path steering reason

probe_type

string

required

Probe Type for the Probe of the DPS Policy for a given BOC, Coule be either Health Check IP, VPNC IP or Custom IP

path_steering_reason

string

required

DPS Reasons, Could be either Latency, Jitter, Packet Drops, MOS or Uplink Down

session_count

integer

required

Session count of the DPS Policy for a given BOC

policy_status

string

required

Status of the DPS Policy for a given BOC, Could either be Compliant or Non Compliant or Partially Compliant

hold_state

integer

required

DPS Hold State Value, Could be either 0,1,2

probe_ip

string

required

Probe IP of the DPS Policy for a given BOC

overall_uplink_result

array of objects

Dps Policies Overall Probe Stats Internal Data

overall_uplink_result

object

path_steering_value

number

required

DPS Value, For a particular path steering reason

probe_type

string

required

Probe Type for the Probe of the DPS Policy for a given BOC, Coule be either Health Check IP, VPNC IP or Custom IP

path_steering_reason

string

required

DPS Reasons, Could be either Latency, Jitter, Packet Drops, MOS or Uplink Down

session_count

integer

required

Session count of the DPS Policy for a given BOC

policy_status

string

required

Status of the DPS Policy for a given BOC, Could either be Compliant or Non Compliant or Partially Compliant

hold_state

integer

required

DPS Hold State Value, Could be either 0,1,2

probe_ip

string

required

Probe IP of the DPS Policy for a given BOC

dps_overall_policy_compliance_stats_data

array of arrays of objects

dps_overall_policy_compliance_stats_data

array of objects

object

timestamp

integer

required

Epoch Timestamp in milliseconds

policy_status

string

required

Status of the DPS Policy for a given BOC, Could either be Compliant or Non Compliant or Partially Compliant

dps_policy_compliance_percentage_data

array of objects

Dps Policy Compliance Percentage Internal Data

dps_policy_compliance_percentage_data

object

uplinks_compliance_percentage

array of objects

List of Dps Policy Uplinks Compliance Percentage Internal Data

uplinks_compliance_percentage

object

uplink_name

string

required

Name of the Uplink configured for DPS Policy for a given BOC

compliance_percentage

number

required

Compliance Percentage of the Uplink configured for DPS Policy for a given BOC

overall_compliance_percentage

number

required

Overall Dps Policies Uplinks Compliance Percentage Data

policy_name

string

required

Name of the DPS Policy for a given BOC

401

Unauthorized

403

Forbidden

404

Request URL Not Found

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-base-url/datapoints/v1/cluster/cluster_id/sdwan_policy/policy_stats/policy_name \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Compliance stats on all the links

400Bad Request

500Internal server error