Metrics Get Edge Firewall Idps Series

Metrics Get Edge Firewall Idps Series

Gets Firewall IDPS time series for the enterprise or the edge over the specified time interval by the specified dimension, e.g. threatImpact. On success, this method returns an array of Firewall IDPS time series data in which each entry corresponds to a single dimension.

Privileges required:

READ EDGE

VIEW_FIREWALL_LOGS undefined

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

Show optional properties

{
    "viewBy": "string",
    "interval": {
        "start": "string"
    },
    "maxSamples": 0
}
{
    "enterpriseId": 0,
    "edgeId": 0,
    "viewBy": "string",
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": "edge_firewall_idps_basic_metrics Object",
    "maxSamples": 0
}
integer
enterpriseId
Optional

enterpriseId

integer
edgeId
Optional

edgeId

string
viewBy
Required

viewBy

interval
interval
Required

interval

edge_firewall_idps_basic_metrics
metrics
Optional

A list of metrics to report.

integer
maxSamples
Required

maxSamples

Responses
200

Request was successfully processed

Returns Array of edge_firewall_idps_time_series_metadata of type(s) application/json 
[
    {
        "name": "HIGH",
        "series": [
            {
                "metric": "threatsCount",
                "startTime": "2023-01-24T22:45:29.593Z",
                "tickInterval": 300000,
                "data": [
                    456050,
                    554466
                ],
                "total": 5422823,
                "min": 0,
                "max": 600229
            }
        ]
    },
    {
        "name": "MEDIUM",
        "series": [
            {
                "metric": "threatsCount",
                "startTime": "2023-01-24T22:45:29.593Z",
                "tickInterval": 300000,
                "data": [
                    436444,
                    535839
                ],
                "total": 5218891,
                "min": 0,
                "max": 582592
            }
        ]
    },
    {
        "name": "LOW",
        "series": [
            {
                "metric": "threatsCount",
                "startTime": "2023-01-24T22:45:29.593Z",
                "tickInterval": 300000,
                "data": [
                    436444,
                    535839
                ],
                "total": 5218891,
                "min": 0,
                "max": 582592
            }
        ]
    }
]

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 '{"interval:"object","maxSamples:"integer","viewBy:"string"}' https://{api_host}/portal/rest/metrics/getEdgeFirewallIdpsSeries
On This Page
Metrics Operations
POST
Metrics Get Edge Firewall Idps Metrics
POST
Metrics Get Edge Firewall Idps Series
POST
Metrics Get Edge Firewall Malicious Ip Metrics
POST
Metrics Get Edge Firewall Url Category Metrics
POST
Metrics Get Edge Firewall Url Reputation Metrics
POST
Metrics Get Enterprise Firewall Edge Summary Metrics
POST
Metrics Get Enterprise Firewall Idps Metrics
POST
Metrics Get Enterprise Firewall Malicious Ip Metrics
POST
Metrics Get Enterprise Firewall Url Category Metrics
POST
Metrics Get Enterprise Firewall Url Reputation Metrics