prolexic-metrics-by-fbm-cidrs

The following shows how to generate the prolexic-metrics-by-fbm-cidrs report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides Flow Based Monitoring metrics data by FBM CIDRs/monitored objects which are in DEPLOYED state. Requires 'fbmCidrs' filter, with 'metric' defaulted to 'bps'. The response includes Unix timestamp and null values for unavailable data.

Business object: allFbmFilters

Data available for: 90 days

Required products: Prolexic IP Protect

Available metrics

MetricDescription
Filter metrics
metricTraffic counts by bits per second bps or packets per secondpps.
Defaults to bps
fbmCidrsThe CIDR block(s) for the flow-based monitoring. Required
Response metrics
startDateTimeThe event's start time.
fbmCidrThe CIDR block(s) for the flow-based monitoring.
fbmTrafficValueThe traffic count in the format specified in the metric (bps or pps).

Available filters

POST request

POST /reporting-api/v1/reports/metrics-by-fbm-cidrs

Sample: /reporting-api/v1/reports/metrics-by-fbm-cidrs?start=2025-03-04T14%3A30%3A00Z&end=2025-03-08T14%3A30%3A00Z&interval=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp.
endString2020-06-01T00:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.
Optional
intervalEnumerationFIVE_MINUTESSpecifies the time interval, one of: FIVE_MINUTES, HOUR, or DAY.

JSON request members

MemberTypeDescription
columnsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersArray of objectsSpecifies a set of custom filters, with each filter's name keying an object with each filter's set of values: fbmCidrs,fbmTrafficValue.

Request body:

{
  "columns": [
    "startDateTime",
    "fbmCidr",
    "fbmTrafficValue"
  ],
  "filters": [
    {
      "name": "metric",
      "values": [
        "bps"
      ]
    },
    {
      "name": "fbmCidrs",
      "values": [
        "192.0.2.0/24"
      ]
    }
  ]
}

# JSON response

Status 200 application/json

Response body:

{
  "columns": [
    "startDateTime",
    "fbmCidr",
    "fbmTrafficValue"
  ],
  "data": [
    {
      "startDateTime": "1741102200000",
      "fbmCidr": "192.0.2.0/24",
      "fbmTrafficValue": 0.1
    }
  ]
}