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 IP Protect

Available metrics

Metric	Description
Filter metrics
`securityConfigs`	The security configs to display metrics for. Required
`metric`	Traffic counts by bits per second `bps` or packets per second`pps`. Defaults to `bps`
`trafficDirection`	The traffic direction based on the metric chosen. Either `in` or `out`. Defaults to `in`.
Response metrics
`startDateTime`	The event's start time.
`securityConfig`	The name of the security config.
`preMitigationTrafficValue`	Mitigation request traffic details.
`postMitigationTrafficValue`	Mitigation return traffic details.
`trafficToOriginValue`	Traffic to origin details.
`fbmTrafficValue`	Flow 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/

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: supports `startDateTime`, `securityConfig`, `preMitigationTrafficValue`,`postMitigationTrafficValue`,`trafficToOriginValue`, `fbmTrafficValue`. 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 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:

{
  "columns": [
    "startDateTime",
    "securityConfig",
    "preMitigationTrafficValue",
    "postMitigationTrafficValue",
    "trafficToOriginValue",
    "fbmTrafficValue"
  ],
  "filters": [
    {
      "name": "securityConfigs",
      "values": [
        "East_config",
        "West_config"
      ]
    },
    {
      "name": "metric",
      "values": [
        "bps"
      ]
    },
    {
      "name": "trafficDirection",
      "values": [
        "in"
      ]
    }
  ]
}

# JSON response

Status 200 application/json

Response body:

{
  "columns": [
    "startDateTime",
    "securityConfig",
    "preMitigationTrafficValue",
    "postMitigationTrafficValue",
    "trafficToOriginValue",
    "fbmTrafficValue"
  ],
  "data": [
    {
      "startDateTime": "1741102200000",
      "securityConfig": "East_config",
      "preMitigationTrafficValue": 0.1,
      "postMitigationTrafficValue": 0.1,
      "trafficToOriginValue": 0.1,
      "fbmTrafficValue": 0.1
    }
  ]
}