Metrics Get Enterprise Firewall Url Category Metrics

Metrics Get Enterprise Firewall Url Category Metrics

Gets URL category summaries for the enterprise over the specified time interval by the specified dimension, e.g. urlCategory, action and sourceIp. On success, this method returns an array of aggregate data in which each entry corresponds to a single dimension.

Privileges required:

READ ENTERPRISE

VIEW_FIREWALL_LOGS undefined

Request
URI
POST
https://{api_host}/portal/rest/metrics/getEnterpriseFirewallUrlCategoryMetrics
COPY
Request Body

Show optional properties

{
    "enterpriseId": 0,
    "interval": {
        "start": "string"
    },
    "viewBy": "string"
}
{
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "viewBy": "string",
    "metrics": [
        "string"
    ],
    "sort": "string",
    "limit": 0,
    "other": false,
    "filters": "metric_filters Object",
    "with": [
        "string"
    ],
    "edgeLogicalIds": [
        "string"
    ]
}
integer
enterpriseId
Required

enterpriseId

interval
Required

interval

string
viewBy
Required

viewBy

Possible values are : urlCategory, action, sourceIp, edgeLogicalId,
array of string
metrics
Optional

metrics

Possible values are : threatsCount, urlsBlockedCount, urlsAllowedCount, urlsMonitoredCount,
string
sort
Optional

sort

Possible values are : threatsCount, urlsBlockedCount, urlsAllowedCount, urlsMonitoredCount,
integer
limit
Optional

limit

boolean
other
Optional

Includes the metrics of the rest apart from the limited result

filters
Optional

filters

array of string
with
Optional

with

array of string
edgeLogicalIds
Optional

edgeLogicalIds

Responses
200

Request was successfully processed

Returns Array of object of type(s) application/json
[
    {
        "urlCategory": 15,
        "urlsBlockedCount": 44
    },
    {
        "urlCategory": 59,
        "urlsBlockedCount": 34
    }
]

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"viewBy:"string","interval:"object","enterpriseId:"integer"}' https://{api_host}/portal/rest/metrics/getEnterpriseFirewallUrlCategoryMetrics