ipa-trafficlost-by-time

The following shows how to generate the ipa-trafficlost-by-time 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 blocked traffic data for IP Application Accelerator.

This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

Business object: cpcode

Data available for: 92 days

Required products: IP Application Accelerator

Available metrics

MetricDescription
Data metrics
blacklistBytesThe volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
blacklistPacketsThe number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
closedPortBytesThe volume of blocked traffic over time from packets dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.
closedPortPacketsThe number of blocked packets over time dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.
geoBytesThe volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.
geoPacketsThe number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistBytesThe blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistPacketsThe number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
otherBytesThe volume of traffic over time blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.
otherPacketsThe number of blocked packets over time, blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.
unsupportedProtocolBytesThe volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
unsupportedProtocolPacketsThe volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
Summary metrics
blacklistBytesTotalThe total volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
blacklistPacketsTotalThe total number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
closedPortBytesTotalThe total volume of blocked traffic over time from packets dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.
closedPortPacketsTotalThe total number of blocked packets over time dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.
geoBytesTotalThe total volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.
geoPacketsTotalThe total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistBytesTotalThe total blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistPacketsTotalThe total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
otherBytesTotalThe total volume of traffic over time blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.
otherPacketsTotalThe total number of blocked packets over time, blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.
unsupportedProtocolBytesTotalThe total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
unsupportedProtocolPacketsTotalThe total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.Y

Available filters

FilterTypeDescription
Optional filters
slotIntegerA unique configuration for a hostname.

POST request

POST /reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies 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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of cpcode values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of ArraysSpecifies a set of custom filters, with each filter's name keying an array with each filter's set of values.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "blacklistBytes",
        "blacklistBytesTotal",
        "blacklistPackets",
        "blacklistPacketsTotal",
        "closedPortBytes",
        "closedPortBytesTotal",
        "closedPortPackets",
        "closedPortPacketsTotal",
        "geoBytes",
        "geoBytesTotal",
        "geoPackets",
        "geoPacketsTotal",
        "globalblacklistBytes",
        "globalblacklistBytesTotal",
        "globalblacklistPackets",
        "globalblacklistPacketsTotal",
        "otherBytes",
        "otherBytesTotal",
        "otherPackets",
        "otherPacketsTotal",
        "unsupportedProtocolBytes",
        "unsupportedProtocolBytesTotal",
        "unsupportedProtocolPackets",
        "unsupportedProtocolPacketsTotal"
    ],
    "filters": {
        "slot": [
            "140",
            "11838"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=blacklistBytes%2CblacklistBytesTotal​&filters​=slot%3D11838%2Cslot%3D140

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs an alternative to objectIds, enabling this generates a report that includes all IDs available for the cpcode objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIdsString55232,​23433,​32433As an alternative to allObjectIds, specifies the set of unique IDs for the cpcode objectType you want to report on, formatted as a comma-delimited list.
metricsStringblacklistBytes,​blacklistBytesTotalSpecifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.
filtersStringslot=​11838,​slot=​140Specifies criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "ipa-trafficlost-by-time",
        "version": "2",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "slot",
                "values": [
                    "11838",
                    "8927"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "blacklistBytes",
                "label": "Blacklist Bytes"
            },
            {
                "name": "blacklistPackets",
                "label": "Blacklist Packets"
            },
            {
                "name": "closedPortBytes",
                "label": "Closed Port Bytes"
            },
            {
                "name": "closedPortPackets",
                "label": "Closed Port Packets"
            },
            {
                "name": "geoBytes",
                "label": "Geo Blacklist Bytes"
            },
            {
                "name": "geoPackets",
                "label": "Geo Blacklist Packets"
            },
            {
                "name": "globalblacklistBytes",
                "label": "Global Blacklist Bytes"
            },
            {
                "name": "globalblacklistPackets",
                "label": "Global Blacklist Packets"
            },
            {
                "name": "otherBytes",
                "label": "Other Bytes"
            },
            {
                "name": "otherPackets",
                "label": "Other Packets"
            },
            {
                "name": "unsupportedProtocolBytes",
                "label": "Unsupported Protocol Bytes"
            },
            {
                "name": "unsupportedProtocolPackets",
                "label": "Unsupported Protocol Packets"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "blacklistBytes": "4465",
            "blacklistPackets": "4392",
            "closedPortBytes": "4406",
            "closedPortPackets": "3097",
            "geoBytes": "1350",
            "geoPackets": "2355",
            "globalblacklistBytes": "2731",
            "globalblacklistPackets": "4291",
            "otherBytes": "1583",
            "otherPackets": "283",
            "unsupportedProtocolBytes": "1242",
            "unsupportedProtocolPackets": "3323"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "blacklistBytes": "355",
            "blacklistPackets": "1207",
            "closedPortBytes": "4989",
            "closedPortPackets": "2217",
            "geoBytes": "4086",
            "geoPackets": "1371",
            "globalblacklistBytes": "4439",
            "globalblacklistPackets": "2579",
            "otherBytes": "1541",
            "otherPackets": "1647",
            "unsupportedProtocolBytes": "3615",
            "unsupportedProtocolPackets": "3849"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "blacklistBytes": "73",
            "blacklistPackets": "3653",
            "closedPortBytes": "2240",
            "closedPortPackets": "801",
            "geoBytes": "4483",
            "geoPackets": "3148",
            "globalblacklistBytes": "4467",
            "globalblacklistPackets": "878",
            "otherBytes": "836",
            "otherPackets": "1404",
            "unsupportedProtocolBytes": "544",
            "unsupportedProtocolPackets": "2611"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "blacklistBytes": "1347",
            "blacklistPackets": "1479",
            "closedPortBytes": "2054",
            "closedPortPackets": "4197",
            "geoBytes": "1340",
            "geoPackets": "272",
            "globalblacklistBytes": "3771",
            "globalblacklistPackets": "4855",
            "otherBytes": "2543",
            "otherPackets": "920",
            "unsupportedProtocolBytes": "3054",
            "unsupportedProtocolPackets": "1266"
        }
    ],
    "summaryStatistics": {
        "blacklistBytesTotal": {
            "value": "1562",
            "details": {}
        },
        "blacklistPacketsTotal": {
            "value": "4266",
            "details": {}
        },
        "closedPortBytesTotal": {
            "value": "3961",
            "details": {}
        },
        "closedPortPacketsTotal": {
            "value": "4323",
            "details": {}
        },
        "geoBytesTotal": {
            "value": "1825",
            "details": {}
        },
        "geoPacketsTotal": {
            "value": "2298",
            "details": {}
        },
        "globalblacklistBytesTotal": {
            "value": "2558",
            "details": {}
        },
        "globalblacklistPacketsTotal": {
            "value": "3702",
            "details": {}
        },
        "otherBytesTotal": {
            "value": "1244",
            "details": {}
        },
        "otherPacketsTotal": {
            "value": "2330",
            "details": {}
        },
        "unsupportedProtocolBytesTotal": {
            "value": "3513",
            "details": {}
        },
        "unsupportedProtocolPacketsTotal": {
            "value": "4403",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​ipa-trafficlost-by-time
version,​2
source,​ipa-trafficlost-by-time/versions/2
groupBy,​startdatetime
start,​2020-06-26T13:40:00Z
end,​2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
slot,​11838,​8927
#METADATA_END

#SUMMARYSTATISTICS_START
blacklistBytesTotal,​1562
blacklistPacketsTotal,​4266
closedPortBytesTotal,​3961
closedPortPacketsTotal,​4323
geoBytesTotal,​1825
geoPacketsTotal,​2298
globalblacklistBytesTotal,​2558
globalblacklistPacketsTotal,​3702
otherBytesTotal,​1244
otherPacketsTotal,​2330
unsupportedProtocolBytesTotal,​3513
unsupportedProtocolPacketsTotal,​4403
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​blacklistBytes,​blacklistPackets,​closedPortBytes,​closedPortPackets,​geoBytes,​geoPackets,​globalblacklistBytes,​globalblacklistPackets,​otherBytes,​otherPackets,​unsupportedProtocolBytes,​unsupportedProtocolPackets
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,4465,​4392,​4406,​3097,​1350,​2355,​2731,​4291,​1583,​283,​1242,​3323
2020-06-26T13:45:00Z,355,​1207,​4989,​2217,​4086,​1371,​4439,​2579,​1541,​1647,​3615,​3849
2020-06-26T13:50:00Z,73,​3653,​2240,​801,​4483,​3148,​4467,​878,​836,​1404,​544,​2611
2020-06-26T13:55:00Z,1347,​1479,​2054,​4197,​1340,​272,​3771,​4855,​2543,​920,​3054,​1266
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the ipa-trafficlost-by-time report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2

Status 200 application/json

Response body:

{
    "name": "ipa-trafficlost-by-time",
    "description": "Provides blocked traffic data for IP Application Accelerator.",
    "businessObjectName": "cpcode",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "IP Application Accelerator"
    ],
    "requiredRoles": [
        "Pulsar IPA/SXL Read Only"
    ],
    "available": true,
    "metrics": [
        {
            "name": "blacklistBytes",
            "description": "The volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.",
            "label": "Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "globalblacklistBytes",
            "description": "The blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Global Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "closedPortBytes",
            "description": "The volume of blocked traffic over time from packets dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.",
            "label": "Closed Port Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "geoBytes",
            "description": "The volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Geo Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "otherBytes",
            "description": "The volume of traffic over time blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.",
            "label": "Other Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "unsupportedProtocolBytes",
            "description": "The volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.",
            "label": "Unsupported Protocol Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "blacklistPackets",
            "description": "The number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.",
            "label": "Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "closedPortPackets",
            "description": "The number of blocked packets over time dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.",
            "label": "Closed Port Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "geoPackets",
            "description": "The number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Geo Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "globalblacklistPackets",
            "description": "The number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Global Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "otherPackets",
            "description": "The number of blocked packets over time, blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.",
            "label": "Other Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "unsupportedProtocolPackets",
            "description": "The volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.",
            "label": "Unsupported Protocol Packets",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "blacklistBytesTotal",
            "description": "The total volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.",
            "label": "Total Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "globalblacklistBytesTotal",
            "description": "The total blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Total Global Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "geoBytesTotal",
            "description": "The total volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Total Geo Blacklist Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "closedPortBytesTotal",
            "description": "The total volume of blocked traffic over time from packets dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.",
            "label": "Total Closed Port Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "otherBytesTotal",
            "description": "The total volume of traffic over time blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.",
            "label": "Total Other Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "unsupportedProtocolBytesTotal",
            "description": "The total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.",
            "label": "Total Unsupported Protocol Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "blacklistPacketsTotal",
            "description": "The total number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.",
            "label": "Total Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "closedPortPacketsTotal",
            "description": "The total number of blocked packets over time dropped because the port is not open on the origin, for example, port 22 traffic on a web server with only ports 80 and 443 open.",
            "label": "Total Closed Port Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "geoPacketsTotal",
            "description": "The total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Total Geo Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "globalblacklistPacketsTotal",
            "description": "The total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.",
            "label": "Total Global Blacklist Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "otherPacketsTotal",
            "description": "The total  number of blocked packets over time, blocked for any reason other than blacklisted IPs, CIDRs, or geographies, closed ports, or unsupported protocols blocked wholesale at the origin.",
            "label": "Total Other Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "unsupportedProtocolPacketsTotal",
            "description": "The total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.Y",
            "label": "Total Unsupported Protocol Packets",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "slot",
            "type": "int",
            "description": "A unique configuration for a hostname.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/ipa-trafficlost-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/ipa-trafficlost-by-time/versions/2/report-data"
        }
    ]
}