Get Enterprise Firewall Url Filtering Category Metrics

Get Enterprise Firewall Url Filtering Category Metrics

Fetch Enhanced Firewall Url Category stats. Metrics include Top Categories Blocked, Top Allowed Urls, etc. The groupBy parameter controls which metric is returned.

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/firewallUrlFilteringCategoryMetrics
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

integer
start
Required

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

integer
end
Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.

string
metrics
Optional

Metrics possible to return when querying firewall url category metrics

Possible values are : threatsCount, urlsBlockedCount, urlsMonitoredCount, urlsAllowedCount, urlsHighRiskCount, urlsMediumRiskCount, urlsLowRiskCount, urlsTrustworthyCount, urlsSuspiciousCount,
string
groupBy
Required

Determines the type of query made when querying firewall url category metrics

Possible values are : urlCategory, action, sourceIp, edgeLogicalId,
string
with
Optional

Additional column to return when querying Enterprise-level Url Category stats

string
sortBy
Optional

Sort URL Category results by a metric, defaults to threatsCount

Possible values are : threatsCount, urlsBlockedCount, urlsMonitoredCount, urlsAllowedCount, urlsHighRiskCount, urlsMediumRiskCount, urlsLowRiskCount, urlsTrustworthyCount, urlsSuspiciousCount,

Responses
200

Request successfully processed

Returns Array of EnterpriseFirewallUrlCatResource of type(s) application/json
[
    {
        "name": "string",
        "threatsCount": "number",
        "urlsBlockedCount": "number",
        "urlsAllowedCount": "number",
        "urlsMonitoredCount": "number",
        "edgeLogicalId": "string"
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation