endpoint-usage-by-method

The following shows how to generate the endpoint-usage-by-method 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 information about the usage of your API endpoints, the HTTP methods that API consumers called on your endpoints, and the HTTP responses for those calls.

Business object: cpcode

Data available for: 90 days

Required products: API Gateway

Available metrics

MetricDescription
Data metrics
edgeBytesThe volume for the amount of API traffic that left the Akamai network.
edgeHitsThe request count.
midgressBytesThe volume for the amount of internal API traffic exchanged between Akamai edge servers.
Summary metrics
edgeBytesMaxThe highest volume for the amount of API traffic that left the Akamai network.
edgeBytesMinThe lowest volume for the amount of API traffic that left the Akamai network.
edgeBytesTotalThe total volume of edge traffic for given objects and filters.
edgeHitsMaxThe highest number of requests.
edgeHitsMinThe lowest number of requests.
edgeHitsTotalThe total number of edge requests for given objects and filters.
midgressBytesMaxThe highest volume for the amount of internal API traffic exchanged between Akamai edge servers.
midgressBytesMinThe lowest volume for the amount of internal API traffic exchanged between Akamai edge servers.
midgressBytesTotalThe total volume for the amount of internal API traffic exchanged between Akamai edge servers.

Available filters

FilterTypeDescription
Optional filters
endpoint_idIntegerThe ID of an API configuration registered with Akamai.
http_methodEnumerationA request method indicating the action performed on a resource.
move: Copies, performs updates required by the move, like updating URLs, then deletes the source.
unlock: Removes a lock on the target resource.
proppatch: Sets or removes properties of the target resource.
delete: Removes all information about the target resource.
put: Replaces existing information about the target resource.
head: Retrieves header information about the target resource, with no message body in the response.
mkcol: Creates a new collection resource.
patch: Updates existing information about the target resource.
propfind: Retrieves properties defined on the target resource.
trace: Creates a message loop-back test along the path to the resource.
post: Sends information to the server.
get: Retrieves information about the target resource.
options: Describes communication methods for the target resource.
lock: Prevents the use of other methods on the target resource.
copy: Duplicates the target resource.
connect: Creates a tunnel to the server.
response_classEnumerationA class of HTTP response status codes, from 0xx through 6xx.
0xx: An aborted action on the client side.
1xx: An informational response, like Continue.
2xx: A successful response.
3xx: Success, but a redirect where the thing you want is somewhere else.
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.
6xx: Invalid headers (defined by Akamai).
response_codeIntegerAn HTTP response status code, for example, 201.

POST request

POST /reporting-api/v1/reports/endpoint-usage-by-method/versions/1/report-data{?start,​end}

Sample: /reporting-api/v1/reports/endpoint-usage-by-method/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00: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-01T00: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.

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": [
        "edgeBytes",
        "edgeBytesMax",
        "edgeBytesMin",
        "edgeBytesTotal",
        "edgeHits",
        "edgeHitsMax",
        "edgeHitsMin",
        "edgeHitsTotal",
        "midgressBytes",
        "midgressBytesMax",
        "midgressBytesMin",
        "midgressBytesTotal"
    ],
    "filters": {
        "endpoint_id": [
            "577596",
            "577599"
        ],
        "http_method": [
            "patch",
            "delete"
        ],
        "response_class": [
            "5xx",
            "2xx"
        ],
        "response_code": [
            "201",
            "403"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/endpoint-usage-by-method/versions/1/report-data{?start,​end,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/endpoint-usage-by-method/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=edgeBytes%2CedgeBytesMax​&filters​=endpoint_id%3D577596%2Cendpoint_id%3D577597%2Chttp_method%3Dput%2Chttp_method%3Dget

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00: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.
endString2020-06-01T00:00:00ZSpecifies if unavailable reports should be shown.
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.
metricsStringedgeBytes,​edgeBytesMaxSpecifies 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.
filtersStringendpoint_id=​577596,​endpoint_id=​577597,​http_method=​put,​http_method=​getSpecifies 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-usage-by-method",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "http_method"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "endpoint_id",
                "values": [
                    "577597",
                    "577598"
                ]
            },
            {
                "name": "http_method",
                "values": [
                    "patch",
                    "put"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "2xx",
                    "5xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "500",
                    "200"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "http_method"
            },
            {
                "name": "edgeBytes",
                "label": "Edge Bytes"
            },
            {
                "name": "edgeHits",
                "label": "Edge Bytes"
            },
            {
                "name": "midgressBytes",
                "label": "Midgress Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "http_method": "delete",
            "edgeBytes": "1613",
            "edgeHits": "3770",
            "midgressBytes": "2823"
        },
        {
            "http_method": "put",
            "edgeBytes": "2325",
            "edgeHits": "1386",
            "midgressBytes": "4066"
        },
        {
            "http_method": "patch",
            "edgeBytes": "1934",
            "edgeHits": "3849",
            "midgressBytes": "4495"
        },
        {
            "http_method": "get",
            "edgeBytes": "2682",
            "edgeHits": "2798",
            "midgressBytes": "3918"
        }
    ],
    "summaryStatistics": {
        "edgeBytesMax": {
            "value": "2435",
            "details": {}
        },
        "edgeBytesMin": {
            "value": "4349",
            "details": {}
        },
        "edgeBytesTotal": {
            "value": "357",
            "details": {}
        },
        "edgeHitsMax": {
            "value": "3005",
            "details": {}
        },
        "edgeHitsMin": {
            "value": "128",
            "details": {}
        },
        "edgeHitsTotal": {
            "value": "328",
            "details": {}
        },
        "midgressBytesMax": {
            "value": "2266",
            "details": {}
        },
        "midgressBytesMin": {
            "value": "1847",
            "details": {}
        },
        "midgressBytesTotal": {
            "value": "935",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​endpoint-usage-by-method
version,​1
source,​endpoint-usage-by-method/versions/1
groupBy,​http_method
start,​2020-05-01T00:00:00Z
end,​2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
endpoint_id,​577597,​577598
http_method,​patch,​put
response_class,​2xx,​5xx
response_code,​500,​200
#METADATA_END

#SUMMARYSTATISTICS_START
edgeBytesMax,​2435
edgeBytesMin,​4349
edgeBytesTotal,​357
edgeHitsMax,​3005
edgeHitsMin,​128
edgeHitsTotal,​328
midgressBytesMax,​2266
midgressBytesMin,​1847
midgressBytesTotal,​935
#SUMMARYSTATISTICS_END

#COLUMNS_START
http_method,​edgeBytes,​edgeHits,​midgressBytes
#COLUMNS_END

#DATA_START
delete,​1613,​3770,​2823
put,​2325,​1386,​4066
patch,​1934,​3849,​4495
get,​2682,​2798,​3918
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/endpoint-usage-by-method/versions/1

Status 200 application/json

Response body:

{
    "name": "endpoint-usage-by-method",
    "description": "Provides information about the usage of your API endpoints, the HTTP methods that API consumers called on your endpoints, and the HTTP responses for those calls.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "API Gateway"
    ],
    "requiredRoles": [
        "API Gateway Viewer",
        "API Gateway Administrator"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeBytes",
            "description": "The volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "edgeBytesMax",
            "description": "The highest volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes Max",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeBytesMin",
            "description": "The lowest volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes Min",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeBytesTotal",
            "description": "The total volume of edge traffic for given objects and filters.",
            "label": "Total Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeHits",
            "description": "The request count.",
            "label": "Edge Bytes",
            "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
        },
        {
            "name": "midgressBytes",
            "description": "The volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "midgressBytesMax",
            "description": "The highest volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes Max",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "midgressBytesMin",
            "description": "The lowest volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes Min",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "midgressBytesTotal",
            "description": "The total volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Total Midgress Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "http_method"
    ],
    "filters": [
        {
            "name": "http_method",
            "type": "enum",
            "description": "A request method indicating the action performed on a resource.",
            "values": [
                {
                    "value": "move",
                    "description": "Copies, performs updates required by the move, like updating URLs, then deletes the source."
                },
                {
                    "value": "unlock",
                    "description": "Removes a lock on the target resource."
                },
                {
                    "value": "proppatch",
                    "description": "Sets or removes properties of the target resource."
                },
                {
                    "value": "delete",
                    "description": "Removes all information about the target resource."
                },
                {
                    "value": "put",
                    "description": "Replaces existing information about the target resource."
                },
                {
                    "value": "head",
                    "description": "Retrieves header information about the target resource, with no message body in the response."
                },
                {
                    "value": "mkcol",
                    "description": "Creates a new collection resource."
                },
                {
                    "value": "patch",
                    "description": "Updates existing information about the target resource."
                },
                {
                    "value": "propfind",
                    "description": "Retrieves properties defined on the target resource."
                },
                {
                    "value": "trace",
                    "description": "Creates a message loop-back test along the path to the resource."
                },
                {
                    "value": "post",
                    "description": "Sends information to the server."
                },
                {
                    "value": "get",
                    "description": "Retrieves information about the target resource."
                },
                {
                    "value": "options",
                    "description": "Describes communication methods for the target resource."
                },
                {
                    "value": "lock",
                    "description": "Prevents the use of other methods on the target resource."
                },
                {
                    "value": "copy",
                    "description": "Duplicates the target resource."
                },
                {
                    "value": "connect",
                    "description": "Creates a tunnel to the server."
                }
            ],
            "required": false
        },
        {
            "name": "response_code",
            "type": "int",
            "description": "An HTTP response status code, for example, 201.",
            "required": false
        },
        {
            "name": "response_class",
            "type": "enum",
            "description": "A class of HTTP response status codes, from 0xx through 6xx.",
            "values": [
                {
                    "value": "0xx",
                    "description": "An aborted action on the client side."
                },
                {
                    "value": "1xx",
                    "description": "An informational response, like Continue."
                },
                {
                    "value": "2xx",
                    "description": "A successful response."
                },
                {
                    "value": "3xx",
                    "description": "Success, but a redirect where the thing you want is somewhere else."
                },
                {
                    "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."
                },
                {
                    "value": "6xx",
                    "description": "Invalid headers (defined by Akamai)."
                }
            ],
            "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-usage-by-method/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/endpoint-usage-by-method/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/endpoint-usage-by-method/versions/1/report-data"
        }
    ]
}