prolexic-metrics-by-security-configs

The following shows how to generate the prolexic-metrics-by-security-configs 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 metrics data (pre/post-mitigation, traffic to origin, and FBM) by security config. Requires a securityConfigs filter. The response includes Unix timestamp and null values for unavailable data.

Business object: securityConfigs

Data available for: 90 days

Required products: Prolexic Routed, Prolexic over ADC, Prolexic Connect, or IP Protect

Available metrics

MetricDescription
startDateTimeThe event's start time.
securityConfigThe name of the security config.
metricThe traffic count metric, either BPS or PPS.
preMitigationTrafficValueAll inbound traffic — both legitimate and malicious, that enters the ​Akamai​ Prolexic platform from the internet via anycast, before reaching the nearest scrubbing center.
postMitigationTrafficValueTraffic after initial mitigation has been applied – includes both the filtered attack traffic and the remaining clean traffic as it transits within ​Akamai​ towards the origin.
trafficToOriginValueLegitimate traffic routed back to the origin infrastructure. This traffic typically follows an asymmetric return path and is subject to origin-specific routing policies.
fbmTrafficValueFlow based monitoring traffic count in the format specified in the metric (BPS or PPS).

POST request

POST /reporting-api/v1/reports/metrics-by-security-configs

Sample: /reporting-api/v1/reports/prolexic-metrics-by-security-configs/versions/1/report-data?start=2025-05-26T15%3A55%3A00Z&end=2025-05-28T16%3A00%3A00Z&interval=FIVE_MINUTES

Required query parameters

TypeSampleDescription
startString2025-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.
endString2025-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.
intervalEnumerationFIVE_MINUTESSpecifies the time interval, one of: FIVE_MINUTES, HOUR, or DAY.

JSON request members

MemberTypeDescription
filtersArray of objectsSpecifies a set of custom filters, with each filter's name keying an array with each filter's set of values:securityConfigs, metric,trafficDirection.
The response data includes only objects for security configs with events matching the query.

Request body

{
  "objectType": "securityConfigs",
  "objectIds": [
    "west_config"
  ],
  "filters": {
    "metric": [
      "BPS"
    ],
    "trafficDirection": [
      "In"
    ],
    "securityConfigs": [
      "west_config"
    ]
  },
  "metrics": [
    "startDateTime",
    "preMitigationTrafficValue",
    "postMitigationTrafficValue",
    "trafficToOriginValue",
    "fbmTrafficValue"
  ]
}

JSON response

Status 200 application/json

Response body

{
   "metadata": {
       "name": "prolexic-metrics-by-security-configs",
       "version": "1",
       "outputType": "HIERARCHICAL",
       "groupBy": [
           "startDateTime",
           "securityConfig"
       ],
       "interval": "FIVE_MINUTES",
       "start": "2025-05-26T15:55:00Z",
       "end": "2025-05-28T16:00:00Z",
       "availableDataEnds": null,
       "suggestedRetryTime": null,
       "rowCount": 577,
       "filters": [
           {
               "name": "metric",
               "values": [
                   "BPS"
               ]
           },
           {
               "name": "trafficDirection",
               "values": [
                   "In"
               ]
           },
           {
               "name": "securityConfigs",
               "values": [
                   "west_config"
               ]
           }
       ],
       "columns": [
           {
               "name": "groupBy",
               "label": "startDateTime"
           },
           {
               "name": "groupBy",
               "label": "securityConfig"
           },
           {
               "name": "startDateTime",
               "label": "startDateTime"
           },
           {
               "name": "preMitigationTrafficValue",
               "label": "Pre Mitigation"
           },
           {
               "name": "postMitigationTrafficValue",
               "label": "Post Mitigation"
           },
           {
               "name": "trafficToOriginValue",
               "label": "Traffic to Origin"
           },
           {
               "name": "fbmTrafficValue",
               "label": "FBM"
           }
       ],
       "objectType": "securityConfigs",
       "objectIds": [
           "west_config"
       ]
   },
   "data": [
       {
           "startDateTime": "2025-05-26T15:55:00Z",
           "data": [
               {
                   "securityConfig": "west_config",
                   "startDateTime": "1748274900000",
                   "preMitigationTrafficValue": "210206720",
                   "postMitigationTrafficValue": "199330112",
                   "trafficToOriginValue": "232423.34",
                   "fbmTrafficValue": "223343.566"
               }
           ]
       }
   ]
   "summaryStatistics": {}
}