endpoint-errors-by-time

The following shows how to generate the endpoint-errors-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 error information for your API endpoints 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: 90 days

Required products: API Gateway

Available metrics

MetricDescription
Data metrics
edgeHitsThe request count.
Summary metrics
edgeHitsMaxThe highest number of requests.
edgeHitsMinThe lowest number of requests.
edgeHitsTotalThe total number of edge requests for given objects and filters.

Available filters

FilterTypeDescription
Optional filters
api_keyIntegerA unique identifier of an API consumer.
endpoint_idIntegerThe ID of an API configuration registered with Akamai.
response_class_errorsEnumerationA class of HTTP response error status codes, for example, 4XX.
4xx: Error, where there's some problem with the client request.
5xx: Error, where there's some problem with how the API server responded to the client request.
response_code_errorsIntegerAn HTTP response error status code, for example, 404.

POST request

POST /reporting-api/v1/reports/endpoint-errors-by-time/versions/1/report-data{?start,‚Äčend,‚Äčinterval}

Sample: /reporting-api/v1/reports/endpoint-errors-by-time/versions/1/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": [
        "edgeHits",
        "edgeHitsMax",
        "edgeHitsMin",
        "edgeHitsTotal"
    ],
    "filters": {
        "api_key": [
            "577595",
            "577597"
        ],
        "endpoint_id": [
            "577596",
            "577595"
        ],
        "response_class_errors": [
            "5xx",
            "4xx"
        ],
        "response_code_errors": [
            "404",
            "503"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/endpoint-errors-by-time/versions/1/report-data{?start,‚Äčend,‚Äčinterval,‚ÄčobjectIds,‚ÄčallObjectIds,‚Äčmetrics,‚Äčfilters}

Sample: /reporting-api/v1/reports/endpoint-errors-by-time/versions/1/report-data?start‚Äč=2020-06-26T13%3A40%3A00Z‚Äč&end‚Äč=2020-06-26T14%3A00%3A00Z‚Äč&interval‚Äč=FIVE_MINUTES‚Äč&objectIds‚Äč=55232,‚Äč23433,‚Äč32433‚Äč&metrics‚Äč=edgeHits%2CedgeHitsMax‚Äč&filters‚Äč=api_key%3D577598%2Capi_key%3D577595%2Cendpoint_id%3D577596%2Cendpoint_id%3D577597

Query parameters

ParameterTypeSampleDescription
Required
startString2022-06-23T13:55: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.
endString2022-06-23T14:15: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.
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.
metricsStringedgeHits,‚ÄčedgeHitsMaxSpecifies 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.
filtersStringapi_key=‚Äč577598,‚Äčapi_key=‚Äč577595,‚Äčendpoint_id=‚Äč577596,‚Äčendpoint_id=‚Äč577597Specifies 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": "endpoint-errors-by-time",
        "version": "1",
        "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": "api_key",
                "values": [
                    "577595",
                    "577598"
                ]
            },
            {
                "name": "endpoint_id",
                "values": [
                    "577599",
                    "577595"
                ]
            },
            {
                "name": "response_class_errors",
                "values": [
                    "5xx",
                    "3xx"
                ]
            },
            {
                "name": "response_code_errors",
                "values": [
                    "100",
                    "403"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "edgeHits",
                "label": "Edge Hits"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgeHits": "15"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgeHits": "23"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgeHits": "4390"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgeHits": "3161"
        }
    ],
    "summaryStatistics": {
        "edgeHitsMax": {
            "value": "4093",
            "details": {}
        },
        "edgeHitsMin": {
            "value": "4708",
            "details": {}
        },
        "edgeHitsTotal": {
            "value": "4780",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,‚Äčendpoint-errors-by-time
version,‚Äč1
source,‚Äčendpoint-errors-by-time/versions/1
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
api_key,‚Äč577595,‚Äč577598
endpoint_id,‚Äč577599,‚Äč577595
response_class_errors,‚Äč5xx,‚Äč3xx
response_code_errors,‚Äč100,‚Äč403
#METADATA_END

#SUMMARYSTATISTICS_START
edgeHitsMax,‚Äč4093
edgeHitsMin,‚Äč4708
edgeHitsTotal,‚Äč4780
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,‚ÄčedgeHits
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,15
2020-06-26T13:45:00Z,23
2020-06-26T13:50:00Z,4390
2020-06-26T13:55:00Z,3161
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/endpoint-errors-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "endpoint-errors-by-time",
    "description": "Provides error information for your API endpoints over time.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "API Gateway"
    ],
    "requiredRoles": [
        "API Gateway Viewer",
        "API Gateway Administrator"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeHits",
            "description": "The request count.",
            "label": "Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "edgeHitsMax",
            "description": "The highest number of requests.",
            "label": "Edge Hits Max",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsMin",
            "description": "The lowest number of requests.",
            "label": "Edge Hits Min",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsTotal",
            "description": "The total number of edge requests for given objects and filters.",
            "label": "Total Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "api_key",
            "type": "int",
            "description": "A unique identifier of an API consumer.",
            "required": false
        },
        {
            "name": "response_code_errors",
            "type": "int",
            "description": "An HTTP response error status code, for example, 404.",
            "required": false
        },
        {
            "name": "response_class_errors",
            "type": "enum",
            "description": "A class of HTTP response error status codes, for example, 4XX.",
            "values": [
                {
                    "value": "4xx",
                    "description": "Error, where there's some problem with the client request."
                },
                {
                    "value": "5xx",
                    "description": "Error, where there's some problem with how the API server responded to the client request."
                }
            ],
            "required": false
        },
        {
            "name": "endpoint_id",
            "type": "int",
            "description": "The ID of an API configuration registered with Akamai.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/endpoint-errors-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/endpoint-errors-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/endpoint-errors-by-time/versions/1/report-data"
        }
    ]
}