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 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 events for. Required |
Response metrics | |
eventStartDateTime | The event's start time in ISO 8601 timestamp format. |
eventStartTimeInMillis | The event's start time in Unix epoch milliseconds. |
securityConfig | The security config name. |
eventType | The event type. Refer to Attack Types. |
destinationIps | The event's destination IP address(es). |
Available filters
POST request
POST /reporting-api/v1/reports/events-by-security-configs
Sample: /reporting-api/v1/reports/events-by-security-configs?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: 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 .The response data includes only objects for security configs with events matching the query. |
Request body:
{
"columns": [
"eventStartDateTime",
"eventStartTimeInMillis",
"securityConfig",
"eventType",
"eventDetails",
"destinationIps"
],
"filters": [
{
"name": "securityConfigs",
"values": [
"East_config",
"west_config"
]
}
]
}
# JSON response
Status 200 application/json
Response body:
{
"columns": [
"eventStartDateTime",
"eventStartDateTimeInMillis",
"securityConfig",
"eventDetails",
"eventType",
"destinationIps"
],
"data": [
{
"eventStartDateTime": "Tuesday, Mar 04, 2025 03:30 PM",
"eventStartTimeInMillis": 1741102200000,
"securityConfig": "East_config",
"eventType": "Attack Alert",
"eventDetails": "PUSH Flood, UDP Fragment",
"destinationIps": [
"192.168.1.1",
"192.168.1.2"
]
}
]
}