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. Requires the fbmProtocols filter, with metric defaulted to BPS. The response includes Unix timestamp and N/A values for unavailable data. The response includes Unix timestamp and N/A values for unavailable data.

Business object: allFbmFilters

Data available for: 90 days

Required products: Prolexic Flow Based Monitoring

Available metrics

Metric	Description
`startDateTime`	The report's start time in ISO 8601 format using UTC time.
`metric`	Traffic counts by bits per second (`BPS`) or packets per second (`PPS`). Defaults to `BPS`.
`fbmTrafficValue`	Origin traffic data transiting the FBM system, based on NetFlow data exported to Akamai's flow aggregation systems within the scrubbing centers.

POST request

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

Sample: /reporting-api/v1/reports/prolexic-metrics-by-fbm-protocols/versions/1/report-data?start=2025-05-26T16%3A05%3A00Z&end=2025-05-28T16%3A10%3A00Z&interval=FIVE_MINUTES

Required query parameters

Parameter	Type	Sample	Description
`start`	String	`2025-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	`2025-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.
`interval`	Enumeration	`FIVE_MINUTES`	Specifies the time interval, one of: `FIVE_MINUTES`, `HOUR`, or `DAY`.

JSON request members

Member	Type	Description
`objectType`	String	Specifies the business object for the report.
`filters`	Object	Specifies a set of custom filters, with each filter's name keying an object with each filter's set of values: `metric`,`fbmProtocol` and `fbmTrafficValue`
`metrics`	Array	The set of desired data metrics. If omitted, the report includes all available metrics.
`fbmProtocols`	Array	Specifies the FBM protocols for the report – any of: `TCP, UDP, GRE, ICMP, 41, ICMPv6`.Required

Request body

{
  "objectType": "allFbmFilters",
  "filters": {
    "metric": [
      "BPS"
    ],
    "fbmProtocols": [
      "TCP"
    ]
  },
  "metrics": [
    "startDateTime",
    "fbmTrafficValue"
  ]
}

JSON response

Status 200 application/json

Response body

{
   "metadata": {
       "name": "prolexic-metrics-by-fbm-cidrs",
       "version": "1",
       "outputType": "HIERARCHICAL",
       "groupBy": [
           "startDateTime",
           "fbmProtocol"
       ],
       "interval": "FIVE_MINUTES",
       "start": "2025-05-26T16:05:00Z",
       "end": "2025-05-28T16:10:00Z",
       "availableDataEnds": null,
       "suggestedRetryTime": null,
       "rowCount": 577,
       "filters": [
           {
               "name": "metric",
               "values": [
                   "BPS"
               ]
           },
           {
               "name": "fbmProtocols",
               "values": [
                   "TCP"
               ]
           }
       ],
       "columns": [
           {
               "name": "groupBy",
               "label": "startDateTime"
           },
           {
               "name": "groupBy",
               "label": "fbmProtocol"
           },
           {
               "name": "startDateTime",
               "label": "startDateTime"
           },
           {
               "name": "fbmTrafficValue",
               "label": "FBM"
           }
       ],
       "objectType": "allFbmFilters",
       "objectIds": [
           "TCP"
       ]
   },
   "data": [
       {
           "startDateTime": "2025-05-26T16:05:00Z",
           "data": [
               {
                   "fbmProtocol": "192.0.2.0/24",
                   "startDateTime": "1748275500000",
                   "fbmTrafficValue": "344566.67"
               }
           ]
       }
   ]
   "summaryStatistics": {}
}