The following shows how to generate the prolexic-events-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 event data by security config. Requires a securityConfigs
filter. The response includes Unix timestamp and N/A 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
Metric | Description |
---|---|
eventStartDateTime | The event's start time in ISO 8601 format using UTC time. |
eventType | The event type, one of the following: - Attack alert - triggered when there is a DDoS attack. - FBM alert - triggered when the FBM threshold is met or crossed. - FBM config - triggered when there is a change in FBM configurations. |
eventDetails | A detailed message about the event. |
destinationIps | The event's destination IP address(es). |
Available filters
Metric | Description |
---|---|
securityConfigs | Specifies the security configs to report. |
POST request
POST /reporting-api/v1/reports/prolexic-events-by-security-configs
Sample: /reporting-api/v1/reports/prolexic-events-by-security-configs/versions/1/report-data?start=2025-03-01T00%3A00%3A00Z&end=2025-05-28T16%3A55%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. |
objectIds | String | Specifies the securityConfigs for the report. |
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 . This should match the strings listed in objectIds .The response data includes only objects for security configs with events matching the query. |
metrics | Array | The set of desired metrics. If omitted, the report includes all available metrics. |
Request body
{
"objectType": "securityConfigs",
"objectIds": [
"west_config"
],
"filters": {
"securityConfigs": [
"west_config"
]
},
"metrics": [
"eventStartDateTime",
"eventType",
"eventDetails",
"destinationIps"
]
}
JSON response
Status 200 application/json
Response body
{
"metadata": {
"name": "prolexic-events-by-security-configs",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"eventStartDateTime"
],
"interval": "FIVE_MINUTES",
"start": "2025-03-01T00:00:00Z",
"end": "2025-05-28T16:55:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 5,
"filters": [
{
"name": "securityConfigs",
"values": [
"west_config"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "eventStartDateTime"
},
{
"name": "eventStartDateTime",
"label": "Date/Time"
},
{
"name": "eventDetails",
"label": "Details"
},
{
"name": "eventType",
"label": "Event type"
},
{
"name": "destinationIps",
"label": "Destination"
}
],
"objectType": "securityConfigs",
"objectIds": [
"west_config"
]
},
"data": [
{
"eventStartDateTime": "Monday, May 05, 2025 05:32 PM",
"eventDetails": "Akamai Flow Anomaly for west_config, destination_ip 203.0.113.0 with top talker SOFTLAYER-R-4-36",
"eventType": "FBM Alert",
"destinationIps": "203.0.113.0"
}
],
"summaryStatistics": {}
}