The following shows how to generate the prolexic-metrics-by-connection-types 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 traffic metrics data by connection types such as routed tunnels, routed tunnels over ADC, VLL circuits, and Protected IPs. The response includes Unix timestamp and null values for unavailable data.

Business object: allConnections

Data available for: 90 days

Required products: Prolexic IP Protect

Available metrics

Metric	Description
Filter metrics
`eventStartDateTime`	The report's start time.
`connectionIp`	The IP address(es) for the connection. Required
`trafficToOriginValue`	The origin traffic count based on the metric chosen.
Response metrics
`startDateTime`	The report's start time in UNIX epoch seconds.
`trafficDirection`	Traffic direction, either `in` or `out`. Defaults to `in`.
`metric`	Traffic counts by bits per second `bps` or packets per second`pps`. Defaults to `bps`
`connectionIps`	The IP address(es) for the connection.
`trafficToOriginValue`	The origin traffic count based on the `metric` value.

POST request

POST /reporting-api/v1/reports/metrics-by-connection-types

Sample: /reporting-api/v1/reports/metrics-by-connection-types?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: `tunnels`, `tunnelsOverAdc`, `circuits`, `protectedIPs`, `metric`, and`trafficDirection`.

Request body:

{
  "columns": [
    "eventStartDateTime",
    "connectionIp",
    "trafficToOriginValue"
  ],
  "filters": [
    {
      "name": "tunnels",
      "values": [
        "192.168.1.1/172.16.0.1"
      ]
    },
    {
      "name": "tunnelsOverAdc",
      "values": [
        "192.168.1.1/172.16.0.1"
      ]
    },
    {
      "name": "circuits",
      "values": [
        "10.0.0.0/31"
      ]
    },
    {
      "name": "protectedIps",
      "values": [
        "192.168.1.0"
      ]
    },
    {
      "name": "metric",
      "values": [
        "bps"
      ]
    },
    {
      "name": "trafficDirection",
      "values": [
        "in"
      ]
    }
  ]
}

# JSON response

Status 200 application/json

Response body:

{
  "columns": [
    "startDateTime",
    "connectionIps",
    "trafficToOriginValue"
  ],
  "data": [
    {
      "startDateTime": "1741102200000",
      "connectionIps": "192.168.1.1/172.16.0.1",
      "trafficToOriginValue": 0.1
    }
  ]
}