midgresshits-by-time

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

Returns data about traffic between Akamai servers over time.

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

Available metrics

MetricDescription
Data metrics
midgressHitsPerSecondThe number of requests between Akamai servers per second for given objects and filters.
midgressHitsPerSecondMaxThe peak number of requests between Akamai servers per second for given objects and filters.
midgressHitsPerSecondMinThe lowest number of requests between Akamai servers per second for given objects and filters.
midgressHitsSlopeRepresents the overall change in traffic volume between Akamai servers over time for given objects and filters, a positive number if increasing or a negative number if decreasing.
midgressHitsTotalAll hits with all response codes delivered from Akamai's Tiered Distribution network, that is bytes served from the Akamai Tiered Distribution infrastructure to edge servers.

Available filters

FilterTypeDescription
Optional filters
delivery_typeEnumerationDistinguishes secure from non-secure traffic.
secure: Secure traffic.
non_secure: Non-secure traffic.
ip_versionEnumerationSupported array values are ipv4 and ipv6.
ipv4: IP address in v4 format.
ipv6: IP address in v6 format.
trafficEnumerationHTTP traffic to be included in the report data.
get_head_responses: Response header traffic from GET operations.
put_post_requests: Request traffic from PUT and POST operations.
all_responses: All response traffic.
put_post_responses: Response traffic from PUT and POST operations.

POST request

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

Sample: /reporting-api/v1/reports/midgresshits-by-time/versions/1/report-data?start​=2019-10-08T13%3A40%3A00Z​&end​=2019-10-08T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2019-10-08T13: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.
endString2019-10-08T14:00:00ZSpecifies if unavailable reports should be shown.
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": [
        "midgressHitsPerSecond",
        "midgressHitsPerSecondMax",
        "midgressHitsPerSecondMin",
        "midgressHitsSlope",
        "midgressHitsTotal"
    ],
    "filters": {
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "ip_version": [
            "ipv4",
            "ipv6"
        ],
        "traffic": [
            "put_post_responses",
            "get_head_responses"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/midgresshits-by-time/versions/1/report-data?start​=2019-10-08T13%3A40%3A00Z​&end​=2019-10-08T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=midgressHitsPerSecond%2CmidgressHitsPerSecondMax​&filters​=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure%2Cip_version%3Dipv4%2Cip_version%3Dipv6

Query parameters

ParameterTypeSampleDescription
Required
startString2019-10-08T13: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.
endString2019-10-08T14: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.
metricsStringmidgressHitsPerSecond,​midgressHitsPerSecondMaxSpecifies 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.
filtersStringdelivery_type=​secure,​delivery_type=​non-secure,​ip_version=​ipv4,​ip_version=​ipv6Specifies 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": "midgresshits-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2019-10-08T13:40:00Z",
        "end": "2019-10-08T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "delivery_type",
                "values": [
                    "secure",
                    "non-secure"
                ]
            },
            {
                "name": "ip_version",
                "values": [
                    "ipv4",
                    "ipv6"
                ]
            },
            {
                "name": "traffic",
                "values": [
                    "put_post_responses",
                    "put_post_requests"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "midgressHitsPerSecond",
                "label": "Midgress Hits/Sec"
            },
            {
                "name": "midgressHitsPerSecondMax",
                "label": "Midgress Hits/Sec Maximum"
            },
            {
                "name": "midgressHitsPerSecondMin",
                "label": "Midgress Hits/Sec Minimum"
            },
            {
                "name": "midgressHitsSlope",
                "label": "Midgress Hits Slope"
            },
            {
                "name": "midgressHitsTotal",
                "label": "Total Midgress Hits"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2019-10-08T13:40:00Z",
            "midgressHitsPerSecond": "2018.990108",
            "midgressHitsPerSecondMax": "4329.362773",
            "midgressHitsPerSecondMin": "3256.999942",
            "midgressHitsSlope": "595",
            "midgressHitsTotal": "267"
        },
        {
            "startdatetime": "2019-10-08T13:45:00Z",
            "midgressHitsPerSecond": "2475.075532",
            "midgressHitsPerSecondMax": "691.53516",
            "midgressHitsPerSecondMin": "1745.101325",
            "midgressHitsSlope": "4684",
            "midgressHitsTotal": "4385"
        },
        {
            "startdatetime": "2019-10-08T13:50:00Z",
            "midgressHitsPerSecond": "3969.41084",
            "midgressHitsPerSecondMax": "4418.873",
            "midgressHitsPerSecondMin": "2279.085968",
            "midgressHitsSlope": "232",
            "midgressHitsTotal": "4946"
        },
        {
            "startdatetime": "2019-10-08T13:55:00Z",
            "midgressHitsPerSecond": "991.305341",
            "midgressHitsPerSecondMax": "1808.540025",
            "midgressHitsPerSecondMin": "2755.667304",
            "midgressHitsSlope": "4098",
            "midgressHitsTotal": "4216"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​midgresshits-by-time
version,​1
source,​midgresshits-by-time/versions/1
groupBy,​startdatetime
start,​2019-10-08T13:40:00Z
end,​2019-10-08T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
delivery_type,​secure,​non-secure
ip_version,​ipv4,​ipv6
traffic,​put_post_responses,​put_post_requests
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​midgressHitsPerSecond,​midgressHitsPerSecondMax,​midgressHitsPerSecondMin,​midgressHitsSlope,​midgressHitsTotal
#COLUMNS_END

#DATA_START
2019-10-08T13:40:00Z,2018.990108,​4329.362773,​3256.999942,​595,​267
2019-10-08T13:45:00Z,2475.075532,​691.53516,​1745.101325,​4684,​4385
2019-10-08T13:50:00Z,3969.41084,​4418.873,​2279.085968,​232,​4946
2019-10-08T13:55:00Z,991.305341,​1808.540025,​2755.667304,​4098,​4216
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/midgresshits-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "midgresshits-by-time",
    "description": "Returns data about traffic between Akamai servers over time.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "midgressHitsPerSecond",
            "description": "The number of requests between Akamai servers per second for given objects and filters.",
            "label": "Midgress Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "midgressHitsPerSecondMax",
            "description": "The peak number of requests between Akamai servers per second for given objects and filters.",
            "label": "Midgress Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "midgressHitsPerSecondMin",
            "description": "The lowest number of requests between Akamai servers per second for given objects and filters. ",
            "label": "Midgress Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "midgressHitsSlope",
            "description": "Represents the overall change in traffic volume between Akamai servers over time for given objects and filters, a positive number if increasing or a negative number if decreasing. ",
            "label": "Midgress Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "midgressHitsTotal",
            "description": "All hits with all response codes delivered from Akamai's Tiered Distribution network, that is bytes served from the Akamai Tiered Distribution infrastructure to edge servers.",
            "label": "Total Midgress Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "delivery_type",
            "type": "enum",
            "description": "Distinguishes secure from non-secure traffic. ",
            "values": [
                {
                    "value": "secure",
                    "description": "Secure traffic. "
                },
                {
                    "value": "non_secure",
                    "description": "Non-secure traffic."
                }
            ],
            "required": false
        },
        {
            "name": "traffic",
            "type": "enum",
            "description": "HTTP traffic to be included in the report data.",
            "values": [
                {
                    "value": "get_head_responses",
                    "description": "Response header traffic from GET operations."
                },
                {
                    "value": "put_post_requests",
                    "description": "Request traffic from PUT and POST operations."
                },
                {
                    "value": "all_responses",
                    "description": "All response traffic."
                },
                {
                    "value": "put_post_responses",
                    "description": "Response traffic from PUT and POST operations. "
                }
            ],
            "required": false
        },
        {
            "name": "ip_version",
            "type": "enum",
            "description": "Supported array values are ipv4 and ipv6.",
            "values": [
                {
                    "value": "ipv4",
                    "description": "IP address in v4 format."
                },
                {
                    "value": "ipv6",
                    "description": "IP address in v6 format."
                }
            ],
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/midgresshits-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/midgresshits-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/midgresshits-by-time/versions/1/report-data"
        }
    ]
}