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 N/A values for unavailable data.
Business object: allConnections
Data available for: 90 days
Required products: Prolexic Routed, Prolexic over ADC, Prolexic Connect, or IP Protect
Available metrics
| Metric | Description |
|---|---|
startDateTime | The report's start time in ISO 8601 format using UTC time. |
connectionIps | The IP address(es) for the connection -- includes tunnels, tunnelsOverAdc, circuits, and protectedIPs |
trafficToOriginValue | Legitimate traffic that is routed back to the origin infrastructure. This traffic typically follows an asymmetric return path and is subject to origin-specific routing policies. |
Available filters
| Filter | Type | Description |
|---|---|---|
tunnels | Array | The source and destination IP pairs used to establish the Prolexic Routed 3.0 GRE connectivity. |
tunnelsOverAdc | Array | The source and destination IPs used to establish the Prolexic over ADC GRE connectivity. |
circuits | Array | The physical Layer 1 ports or circuits in Prolexic Routed Connect which provide peer-to-peer connectivity between the Akamai scrubbing centers and the origin. |
protectedIps | Array | The virtual IPs (VIPs) assigned to the configuration to support the origin in the Prolexic IP Protect. |
POST request
POST /reporting-api/v1/reports/prolexic-metrics-by-connection-types
Sample:
/reporting-api/v1/reports/prolexic-metrics-by-connection-types/versions/1/report-data?start=2025-03-04T14%3A30%3A00Z&end=2025-03-08T14%3A30%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 array with each filter's set of values: tunnels, tunnelsOverAdc, circuits, protectedIPs, metric and trafficDirection. |
metric | Array | Traffic units – bits per second (BPS) or packets per second (PPS). Defaults to BPS. |
tunnels | Array | The source and destination IP pairs used to establish the Prolexic Routed 3.0 GRE connectivity. |
tunnelsOverAdc | Array | The source and destination IPs used to establish the Prolexic over ADC GRE connectivity. |
circuits | Array | The physical Layer 1 ports or circuits in Prolexic Routed Connect which provide peer-to-peer connectivity between the Akamai scrubbing centers and the origin. |
protectedIps | Array | The virtual IPs (VIPs) assigned to the configuration to support the origin in the Prolexic IP Protect. |
metrics | Array | The set of desired metrics. If omitted, the report includes all available metrics. |
trafficDirection | Array | The direction of the traffic flow through the Akamai scrubbing network, either In or Out . |
Request body:
{
"objectType": "allConnections",
"filters": {
"metric": [
"BPS"
],
"trafficDirection": [
"In"
],
"tunnels": [
"192.168.1.3/172.16.0.2"
],
"tunnelsOverAdc": [
"192.168.1.1/172.16.0.1"
],
"circuits": [
"10.0.0.0/31"
],
"protectedIps": [
"192.168.1.0"
]
},
"metrics": [
"startDateTime",
"trafficToOriginValue"
]
}
JSON response
Status 200 application/json
Response body
{
"metadata": {
"name": "prolexic-metrics-by-connection-types",
"version": "1.0",
"outputType": "HIERARCHICAL",
"groupBy": [
"startDateTime",
"connectionIps"
],
"interval": "FIVE_MINUTES",
"start": "2025-05-13T04:00:00Z",
"end": "2025-05-15T23:40:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 812,
"filters": [
{
"name": "metric",
"values": [
"BPS"
]
},
{
"name": "trafficDirection",
"values": [
"In"
]
},
{
"name": "tunnels",
"values": [
"192.168.1.3/172.16.0.2"
]
},
{
"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"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startDateTime"
},
{
"name": "groupBy",
"label": "connectionIps"
},
{
"name": "startDateTime",
"label": "startDateTime"
},
{
"name": "trafficToOriginValue",
"label": "Traffic to Origin Data"
}
],
"objectType": "allConnections",
"objectIds": [
"192.168.1.3/172.16.0.2",
"192.168.1.1/172.16.0.1",
"10.0.0.0/31",
"192.168.1.0"
]
},
"data": [
{
"startDateTime": "2025-05-13T04:00:00Z",
"data": [
{
"connectionIps": "192.168.1.3/172.16.0.2",
"startDateTime": "1747108800000",
"trafficToOriginValue": "10987.33"
},
{
"connectionIps": "192.168.1.1/172.16.0.12",
"startDateTime": "1747108800000",
"trafficToOriginValue": "1097.33"
},
{
"connectionIps": "10.0.0.0/31",
"startDateTime": "1747108800000",
"trafficToOriginValue": "4.15"
},
{
"connectionIps": "192.168.1.0",
"startDateTime": "1747108800000",
"trafficToOriginValue": "N/A"
}
]
}
]
}