The following shows how to generate the prolexic-metrics-by-fbm-protocols 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 protocols. It requires 'fbmProtocols' 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

Metric	Description
Filter metrics
`startDateTime`	The report's start time.
`metric`	Traffic counts by bits per second `bps` or packets per second`pps`. Defaults to `bps`.
`fbmProtocols`	The protocol type monitored by Flow Based Monitoring. Required
Response metrics
`startDateTime`	The report's start time in UNIX epoch seconds.
`fbmProtocol`	The IP protocol type(s) monitored by FBM. Any of:`TCP`, `UDP`, `GRE`, `ICMP`, `41`, `ICMPv6`.
`fbmTrafficValue`	The traffic count in the format specified in the `metric` (`bps` or `pps`).

POST request

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

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

Query parameters

Parameter	Type	Sample	Description
Required
`start`	String	`2020-05-01T00:00:00Z`	Specifies 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.
`end`	String	`2020-06-01T00:00:00Z`	Specifies 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
`interval`	Enumeration	`FIVE_MINUTES`	Specifies the time interval, one of: `FIVE_MINUTES`, `HOUR`, or `DAY`.

JSON request members

Member	Type	Description
`columns`	Array	The set of desired metrics. If omitted, the report includes all available metrics.
`filters`	Array of objects	Specifies a set of custom filters, with each filter's name keying an object with each filter's set of values: `fbmProtocol` and `fbmTrafficValue`

Request body:

{
  "columns": [
    "startDateTime",
    "fbmProtocol",
    "fbmTrafficValue"
  ],
  "filters": [
    {
      "name": "metric",
      "values": [
        "bps"
      ]
    },
    {
      "name": "fbmProtocols",
      "values": [
        "TCP",
        "UDP"
      ]
    }
  ]
}

# JSON response

Status 200 application/json

Response body:

{
  "columns": [
    "startDateTime",
    "fbmProtocol",
    "fbmTrafficValue"
  ],
  "data": [
    {
      "startDateTime": "1741102200000",
      "fbmProtocol": "TCP",
      "fbmTrafficValue": 0.1
    },
    {
      "startDateTime": "1741102200000",
      "fbmProtocol": "UDP",
      "fbmTrafficValue": 10.24
    }
  ]
}