prolexic-metrics-by-scrubbing-centers

The following shows how to generate the prolexic-metrics-by-scrubbing-centers 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) by scrubbing center. It requires a 'scrubbingCenters' filter, with 'metric' defaulted to 'bps'. The response includes Unix timestamp and null values for unavailable data.

Business object: scrubbingCenters

Data available for: 90 days

Required products: Prolexic IP Protect

Available metrics

MetricDescription
Filter metrics
startDateTimeThe report's start time.
metricTraffic counts by bits per second bps or packets per secondpps.
Defaults to bps
scrubbingCenterThe scrubbing centers to view metrics.
preMitigationTrafficValueMitigation request traffic details.
postMitigationTrafficValueMitigation return traffic details.
Response metrics
startDateTimeThe report's start time in UNIX epoch seconds.
preMitigationTrafficValueMitigation request traffic details.
postMitigationTrafficValueMitigation return traffic details.
scrubbingCenterThe scrubbing center.

POST request

POST /reporting-api/v1/reports/metrics-by-scrubbing-centers

Sample: /reporting-api/v1/reports/metrics-by-scrubbing-centers?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 array with each filter's set of values: metric, scrubbingCenters.
The response data includes only objects for scrubbing centers with metrics matching the query.

Request body:

{
  "columns": [
    "startDateTime",
    "scrubbingCenter",
    "preMitigationTrafficValue",
    "postMitigationTrafficValue"
  ],
  "filters": [
    {
      "name": "metric",
      "values": [
        "bps"
      ]
    },
    {
      "name": "scrubbingCenters",
      "values": [
        "AKL5"
      ]
    }
  ]
}

# JSON response

Status 200 application/json

Response body:

{
  "columns": [
    "startDateTime",
    "scrubbingCenter",
    "preMitigationTrafficValue",
    "postMitigationTrafficValue"
  ],
  "data": [
    {
      "startDateTime": "1741102200000",
      "scrubbingCenter": "AKL5",
      "preMitigationTrafficValue": 0.1,
      "postMitigationTrafficValue": 0.1
    }
  ]
}