Query Time Series Application QoS Metrics (v2.0)

POST 
https://api.sase.paloaltonetworks.com/sdwan/v2.0/api/monitor/application/qos_metrics

Query the time series application QoS metrics.

Request

application/json

Body

Filters for application qos metrics

end_timedate

The end time to get the application QoS metrics.

filter ApplicationQosMetricsFilterrequired

Filters according to the specifications.

application_namestringrequired

Filter by the name of the application.

directionstring

Filter by the traffic direction.

Possible values: [Ingress, Egress]

emailstring[]

Filter by the email address.

sitestring[]

Filter by the site.

userstring[]

Filter by user.

intervalstringrequired

The interval time of the application QoS metrics.

Possible values: [10sec, 1min, 5min, 1hour, 1day, 1month]

max_datapointsint32

The max datapoints of the application QoS metrics.

metrics Metrics[]required

Details of the application QoS metrics.

Array [

namestringrequired

Name: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)

statisticsstring[]required

Statistics: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)

unitstringrequired

Unit: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)

]

namestring

The name of the Application QoS metric.

start_timedate

The start time to get the application QoS metrics.

view View

View the application QoS metrics.

individualstring

The individual view values.

Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, USER, USER_EMAIL, RESOLUTION_QUALITY, None]

summaryboolean

The summary of the view.

Responses

200

Successful Operation

application/json

Schema

Schema

metrics MetricArray[]
Details of the application metrics.
Array [
series Series[]
Series
Array [
data Data[]
Data
Array [
datapoints Datapoints[]
Datapoints
Array [
durationdate-time
The date and time of the series.
filter_property_idstring
The filter property ID.
linksstring[]
Links
max_value_timedate-time
ninetieth_percentilenumber
Ninetieth Percentile
sitesstring[]
The sites.
valuenumber
The values of the filter.
]
statisticsobject
Statistics
]
intervalstring
The interval time.
namestring
The name.
unitstring
Unit
viewobject
View the active series details.
]
]

Example (auto)

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2024-07-29T15:51:28.071Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "max_value_time": "2024-07-29T15:51:28.071Z",
                  "ninetieth_percentile": 0,
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
codestring
The error code.
messagestring
The error message.
]

Example (auto)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "REQUIRED_PROPERTY"
      },
      {
        "code": "INVALID_STATS_REQUEST_BODY"
      },
      {
        "code": "INVALID_FILTER"
      },
      {
        "code": "APPLICATION_NOT_SUPPORTED"
      },
      {
        "code": "MULTIPLE_QOS_TYPE_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED"
      },
      {
        "code": "MAX_DATAPOINTS_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_VIEW_NOT_SUPPORTED"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "OTHER_METRICS_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC"
      },
      {
        "code": "MOS_METRICS_NOT_SUPPORTED"
      },
      {
        "code": "SERVICE_UNAVAILABLE"
      }
    ]
  }
}

• curl
• python
• go
• nodejs
• csharp
• php

• CURL

curl -L 'https://api.sase.paloaltonetworks.com/sdwan/v2.0/api/monitor/application/qos_metrics' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "end_time": "2024-07-29",
  "filter": {
    "application_name": "string",
    "direction": "Ingress",
    "email": [
      "string"
    ],
    "site": [
      "string"
    ],
    "user": [
      "string"
    ]
  },
  "interval": "10sec",
  "max_datapoints": 0,
  "metrics": [
    {
      "name": "string",
      "statistics": [
        "string"
      ],
      "unit": "string"
    }
  ],
  "name": "string",
  "start_time": "2024-07-29",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}'

Request Collapse all

Base URL

https://api.sase.paloaltonetworks.com

Body

{
  "end_time": "2024-07-29",
  "filter": {
    "application_name": "string",
    "direction": "Ingress",
    "email": [
      "string"
    ],
    "site": [
      "string"
    ],
    "user": [
      "string"
    ]
  },
  "interval": "10sec",
  "max_datapoints": 0,
  "metrics": [
    {
      "name": "string",
      "statistics": [
        "string"
      ],
      "unit": "string"
    }
  ],
  "name": "string",
  "start_time": "2024-07-29",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}

ResponseClear

Click the Send API Request button above and see the response here!