API Gateway reports

Endpoints by Method or Status report

The Endpoints by Method/Status report provides information about the HTTP methods that API consumers called on your API endpoints and the response codes that your API endpoints returned.

Filters
The Endpoints by Method or Status report lets you filter the data included in the report by the following criteria:

  • CP code (required). Content provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes have ties to one or more services, which are tracked and reported under that CP code.

  • Endpoint. An API configuration registered with ​Akamai​.

  • HTTP method. A request method indicating the action performed on a resource.

  • Response code. An HTTP response status code, for example, 201.

Metrics
This report displays one of the following statistics:

  • Hits. The request count.

  • Egress bytes. The bandwidth for the amount of API traffic that left the network.

  • Midgress bytes. The bandwidth for the amount of internal API traffic exchanged between edge servers.

Endpoints Usage by Identifier report

The Endpoints Usage by Identifier report has information about the usage of your API endpoints over time and the API keys included in the incoming API requests.

Filters
The Endpoints Usage by Identifier report lets you filter the data included in the report by certain criteria:

  • CP code (required). Content provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes have ties to one or more services, which are tracked and reported under that CP code.

  • Endpoint. An API configuration registered with ​Akamai​.

  • API key. A unique identifier of an API consumer.

Metrics
This report displays one of the following statistics:

  • Hits. The request count.

  • Egress bytes. The bandwidth for the amount of API traffic that left the network.

  • Midgress bytes. The bandwidth for the amount of internal API traffic exchanged between edge servers.

Errors by Key report

The Errors by Key report provides information about error response codes (4XX and 5XX ) that your API endpoints returned and the API keys that caused the error responses.

Filters
The Errors by Key report lets you filter data using several criteria:

  • CP code (required). Content provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes have ties to one or more services, which are tracked and reported under that CP code.

  • API key. A unique identifier of an API consumer.

  • Endpoint. An API configuration registered with ​Akamai​.

  • Response class. A class of HTTP response status codes, such as 2XX.

  • Response code. An HTTP response status code, such as 201.

Metrics

  • HTTP error status frequency. The request count for each selected error response class.

  • Errors by key. The request count for each selected error response code, API key, and endpoint combination.

JWT Denials report

The JWT Denials report provides information about the API requests that failed the JWT validation, the denial reason for each rejected request, and the claim that caused the validation failure.

Filters
The JWT Denials report lets you filter using certain criteria:

  • CP code (required). Content provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes have ties to one or more services, which are tracked and reported under that CP code.

  • Endpoint. An API configuration registered with ​Akamai​.

  • Denial Reason. A JWT-related reason for rejecting a request.

  • Failed Claim. A JWT claim that failed the validation.

Metrics

  • Hits by denial reasons. The request count for each selected denial reason, shown for each selected denial reason, failed claim, and endpoint combination.

Quota Usage by Time report

This report shows the quota usage by given API key by time.

Filters

  • API key. API key for which to show quota usage.

Metrics

  • Quota used. A number of API hits that have been counted towards quota.

Did this page help you?