List top outliers
Retrieve an aggregated list of top outlier sites that consume more bandwidth than allocated.
Query Parameters
- agg_by string
Must be
tenant
. Using the query parameter returns all the aggregated responses for the current parent tenant and its child tenants. If not used, the results for just the current tenant are returned.Example: tenant
Header Parameters
- X-PANW-Region string
Must be one of the following:
de
,americas
,europe
,uk
,sg
,ca
,jp
,au
,in
. Returns details from the Cortex Data Lake (CDL) region specified. If no region is specified, the default response isamericas
CDL region.Example: americas
- application/json
Request Body
filter object
Outliers filter. Consists of a required operator and an array of rules objects.
operator string requiredMust be
AND
.rules object[]
See OutlierRule and TimeFilter.
- anyOf
- OutlierRule
- TimeFilter
Array [operator stringFilter operator that is one of the example values and is run on the property field
property stringFilter property field that is one of the example values
values string[]Filter property value
]Array [operator stringFilter operator that is one of the example values and is run on the property field
property stringFilter property field that is one of the example values
values string[]Filter property value
]Array [object]properties object[] required
List of property json objects
Array [alias stringproperty stringOutliers status property fields will be returned in the API response. See OutliersProperty.
]
- 200
- 400
- 500
Success
- application/json
- Schema
- Top Outliers
Schema
- any
[
{
"bandwidth_consumed": 10,
"site_name": "<site_name>",
"unit": "Kbps"
},
{
"bandwidth_consumed": 100,
"count": 9,
"site_name": "<site_name>",
"unit": "Kbps"
}
]
Bad Request
Server Error