sxl-trafficlost-by-time report

The following shows how to generate the sxl-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

This report allows you to configure the aggregation interval for each data record.

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: Session Accelerator

Available metrics

Metric Description
Data metrics
blacklistBytes The volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
blacklistPackets The number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
closedPortBytes 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.
closedPortPackets 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.
geoBytes The volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.
geoPackets The number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistBytes The blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistPackets The number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
otherBytes 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.
otherPackets 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.
unsupportedProtocolBytes The volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
unsupportedProtocolPackets The volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
Summary metrics
blacklistBytesTotal The total volume of blocked traffic over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
blacklistPacketsTotal The total number of blocked packets over time from blacklisted IP addresses or CIDRs from Fast IP Blocking.
closedPortBytesTotal 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
closedPortPacketsTotal 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
geoBytesTotal The total volume of blocked traffic over time from blacklisted geographies (countries) from Fast IP Blocking.
geoPacketsTotal The total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistBytesTotal The total blocked volume in bytes of traffic from blacklisted geographies (countries) from Fast IP Blocking.
globalblacklistPacketsTotal The total number of blocked packets over time from blacklisted geographies (countries) from Fast IP Blocking.
otherBytesTotal 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.
otherPacketsTotal 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.
unsupportedProtocolBytesTotal The total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.
unsupportedProtocolPacketsTotal The total volume of blocked traffic over time from protocols that are blocked wholesale at the origin, for example, GRE traffic.

Available filters

Filter Type Description
Optional filters
slot Integer A unique configuration for a hostname.

Sample report

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

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

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40: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-26T14: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 The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

Member Type Description
objectIds Array Specifies the set of cpcode values you want to report on.
objectIds Enumeration As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metrics Array The set of desired metrics. If omitted, the report includes all available metrics.
filters Map of Arrays Specifies 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",
            "8927"
        ]
    }
}

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

Sample: /reporting-api/v1/reports/sxl-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%3D8927%2Cslot%3D140

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40: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.
end String 2020-06-26T14:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIds Boolean true As 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.
objectIds String 55232,23433,32433 As 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.
metrics String blacklistBytes,blacklistBytesTotal Specifies 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.
filters String slot=8927,slot=140 Specifies 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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "sxl-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": [
                    "140",
                    "11838"
                ]
            }
        ],
        "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": "3096",
            "blacklistPackets": "4733",
            "closedPortBytes": "2636",
            "closedPortPackets": "344",
            "geoBytes": "3549",
            "geoPackets": "3425",
            "globalblacklistBytes": "949",
            "globalblacklistPackets": "4295",
            "otherBytes": "1243",
            "otherPackets": "4449",
            "unsupportedProtocolBytes": "205",
            "unsupportedProtocolPackets": "490"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "blacklistBytes": "4280",
            "blacklistPackets": "3909",
            "closedPortBytes": "4170",
            "closedPortPackets": "2951",
            "geoBytes": "542",
            "geoPackets": "837",
            "globalblacklistBytes": "1484",
            "globalblacklistPackets": "877",
            "otherBytes": "1774",
            "otherPackets": "4578",
            "unsupportedProtocolBytes": "4626",
            "unsupportedProtocolPackets": "2369"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "blacklistBytes": "2930",
            "blacklistPackets": "4772",
            "closedPortBytes": "1486",
            "closedPortPackets": "268",
            "geoBytes": "3878",
            "geoPackets": "3218",
            "globalblacklistBytes": "3979",
            "globalblacklistPackets": "1440",
            "otherBytes": "3211",
            "otherPackets": "307",
            "unsupportedProtocolBytes": "150",
            "unsupportedProtocolPackets": "3119"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "blacklistBytes": "4388",
            "blacklistPackets": "2609",
            "closedPortBytes": "2424",
            "closedPortPackets": "3494",
            "geoBytes": "4029",
            "geoPackets": "2398",
            "globalblacklistBytes": "2662",
            "globalblacklistPackets": "3200",
            "otherBytes": "1815",
            "otherPackets": "1691",
            "unsupportedProtocolBytes": "4495",
            "unsupportedProtocolPackets": "3583"
        }
    ],
    "summaryStatistics": {
        "blacklistBytesTotal": {
            "value": "4722",
            "details": {}
        },
        "blacklistPacketsTotal": {
            "value": "2346",
            "details": {}
        },
        "closedPortBytesTotal": {
            "value": "817",
            "details": {}
        },
        "closedPortPacketsTotal": {
            "value": "605",
            "details": {}
        },
        "geoBytesTotal": {
            "value": "4817",
            "details": {}
        },
        "geoPacketsTotal": {
            "value": "2244",
            "details": {}
        },
        "globalblacklistBytesTotal": {
            "value": "1263",
            "details": {}
        },
        "globalblacklistPacketsTotal": {
            "value": "1813",
            "details": {}
        },
        "otherBytesTotal": {
            "value": "2697",
            "details": {}
        },
        "otherPacketsTotal": {
            "value": "3542",
            "details": {}
        },
        "unsupportedProtocolBytesTotal": {
            "value": "3446",
            "details": {}
        },
        "unsupportedProtocolPacketsTotal": {
            "value": "2879",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,sxl-trafficlost-by-time
version,2
source,sxl-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,140,11838
#METADATA_END

#SUMMARYSTATISTICS_START
blacklistBytesTotal,4722
blacklistPacketsTotal,2346
closedPortBytesTotal,817
closedPortPacketsTotal,605
geoBytesTotal,4817
geoPacketsTotal,2244
globalblacklistBytesTotal,1263
globalblacklistPacketsTotal,1813
otherBytesTotal,2697
otherPacketsTotal,3542
unsupportedProtocolBytesTotal,3446
unsupportedProtocolPacketsTotal,2879
#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,3096,4733,2636,344,3549,3425,949,4295,1243,4449,205,490
2020-06-26T13:45:00Z,4280,3909,4170,2951,542,837,1484,877,1774,4578,4626,2369
2020-06-26T13:50:00Z,2930,4772,1486,268,3878,3218,3979,1440,3211,307,150,3119
2020-06-26T13:55:00Z,4388,2609,2424,3494,4029,2398,2662,3200,1815,1691,4495,3583
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "sxl-trafficlost-by-time",
    "description": "This report allows you to configure the aggregation interval for each data record.",
    "businessObjectName": "cpcode",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Session 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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "unsupportedProtocolPacketsTotal",
            "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 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-reports-executor-api/v1/reports/sxl-trafficlost-by-time/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/sxl-trafficlost-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/sxl-trafficlost-by-time/versions/2/report-data"
        }
    ]
}