Guide
TrainingSupportCommunity

Data Products reports

Suggest Edits

Cloud Monitor report

EdgeConnect, commonly referred to as Cloud Monitor, provides near real-time logging data for your site's HTTP traffic. This product uses a POST request to transmit receipts to one or more web servers on your network. These receipts contain information about the transactions that are delivered through the edge platform to your end users.

Filters
Select at least one required filter in every report. For optional filters, making no selection returns all associated data for that filter.

  • Customer Data. Can include any business object that is the basis of the report, such as CP codes, Contracts, or DNS zones. Note that CP codes can sometimes be identified as Traffic Segments.

  • 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.

  • Traffic Type. The delivered traffic is either non-secure traffic or secure traffic.

Metrics

  • Cloud monitor log lines. The number of aggregated log lines (forward requests containing HTTP event
    data at the edge sent in an HTTPS POST request from ​Akamai​ edge servers to your origin.

  • Edge requests. The number of HTTP transactions per second delivered through the edge platform to your end users.

  • Cloud monitor log line requests/sec. The rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from ​Akamai​ edge servers to your origin) per second, for the selected date range, traffic segments (CP codes), and traffic type.

  • Maximum log line request/sec. The highest rate of aggregated log lines (forward requests containing
    HTTP event data at the edge sent in an HTTPS POST request from ​Akamai​ edge servers to your origin) per second.

  • Latest log line requests/sec. The most recent measurement of the rate of aggregated log lines (forward
    requests containing HTTP event data at the edge sent in an HTTPS POST request from ​Akamai​ edge servers to your origin) per second, for the selected date range, traffic segments (CP codes), and traffic type.

  • Edge requests/sec. The rate of HTTP transactions per second delivered through the edge platform to your end users, for the selected date range, traffic segments (CP codes), and traffic type.

  • Maximum edge requests/sec. The highest number of HTTP transactions per second delivered through the
    edge platform to your end users, for the selected date range, traffic segments (CP codes), and traffic type.

  • Latest edge requests/sec. The most recent measurement of the number of HTTP transactions per second
    delivered through the edge platform to your end users, for the selected date range, traffic segments (CP codes), and traffic type.

  • Requests per traffic segment. The number of HTTP transactions delivered through the edge platform to
    your end users per traffic segment (CP code).

What else is in play?
Viewing data in this report depends on setting up the Cloud Monitor Instrumentation behavior in Property Manager and configuring the associated API. Be sure to review your configurations and to check that those settings are deployed to production.

API Usage Details report

The API Usage details report allows you to audit details of latest individual API calls (top 5000 in UI, top 25000 through API) for a given time frame (data retention for 90 days), providing additional filtering criteria.

📘

To use this report, you need to be an admin for ​​Akamai Control Center​.

There are two versions of the API Usage Details report:

  • API Usage Details. The older report version, which gets data from the Reporting API v1.
  • API Usage Details (new). The latest report version, which gets data from the Reporting API v2 .

Filters
Select at least one required filter in every report. For optional filters, making no selection returns all associated data for that filter.

  • Client owners. The list of owners of OPEN API clients.

  • Client token. Client token used for generating API request.

  • Endpoints. An API endpoint enabled by ​Akamai​.

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

  • Responses. Response for the API request. You can select Error or Success, and Response Class (0xx-6xx), and Response code filter.

  • URI string search. The portion of a URL with report data you want to see. You can put limits on the search with a custom string search (using the following match criteria: Contains, Starts with, Ends with, Does not contain, Does not start with, Does not end with, Match a regular expression, Does not match a regular expression, or Is an exact match). You can also add a URL pattern to match.

Metrics
Individual requests details sorted by the latest timestamp.

  • Date/time. Date and time of API request.

  • Client owner. Username of client owner.

  • Client IP. The IP generating API request.

  • Client ID. The ID of a client generating API request.

  • Client token. Client token used for generating API request.

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

  • URI. API request details.

  • Response. Response code for the API request against APIs.

In the API Usage Details (new) report, you can see more data in a CSV file you can download. The file shows this additional data:

  • Account ID. Customer account identifier linked to an API request.
  • Contract type. Contract type identifier associated with an API client.
  • Response class. A class of HTTP response status codes. For example, 2xx.
  • Response status. An indicator of whether the HTTP response resulted in a success or an error.
  • Endpoint. A specific API configuration.

API Usage report

The API usage report allows users to audit which users are using APIs and which APIs are most frequently or heavily used.

📘

To use this report, you need to be an admin for ​​Akamai Control Center​.

There are two versions of the API Usage report:

  • API Usage. The older report version, which gets data from the Reporting API v1.
  • API Usage (new). The latest report version, which gets data from the Reporting API v2 .

Filters
Select at least one required filter in every report. For optional filters, making no selection returns all associated data for that filter.

  • Agent family. Family of the API client used.

  • Client owners. The list of owners of OPEN API clients.

  • Endpoints. An API endpoint enabled by ​Akamai​.

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

  • Responses. Response for the API request. You can select Error or Success, and Response Class (0xx-6xx), and Response code filter.

Metrics

  • Total requests. Total requests for a given time frame.

  • Total volume. The total bandwidth used for requests.

  • Requests/volume by time. The number of requests/bytes for a given time.

  • Requests/volume by client owner. The number of requests/bytes by client owner.

  • Requests/volume % by client owner. The percentage of requests/bytes by client owner.

  • Request/volume by endpoint. The number of requests/bytes by endpoint.

  • Request/volume % by endpoint. The percentage of requests/bytes by endpoint.

  • Requests/volume by HTTP method. The percentage of requests/bytes by the HTTP method.

  • Requests/volume by agent family. The percentage of requests/bytes by the agent family.

Purge Usage report

This report provides various levels of details of your purge requests in different dimensions such as time, environment, action, and type, as well as details of purge requests and objects for audit purposes.

There are two versions of the Purge Usage report:

  • Purge Usage. The older report version, which gets data from the Reporting API v1.
  • Purge Usage (new). The latest report version, which gets data from the Reporting API v2 .

You can switch between three views:

  • Requests. It's an overview of the number of purge requests and objects in different dimensions such as time, client name, environment, action, type, source, and response code.
  • Requests details.
  • Object details.

The Request details and Object details views are limited to 5000 results. For more results (up to 25000), use the API.

Filters

This report has optional filters. Making no selection returns all associated data for a filter.

All views

  • Client owner. Externally visible customer username of an API client associated with a purge request.
  • Client name. Name given to an API client by the user who creates it; applicable to service accounts.
  • Request action. Purge action desired on request object: Delete, Invalidate.
  • Request type. Type associated to request object: ARL, CP code, Tag, URL, VCD.
  • Request source. Source of a purge request: EdgeGrid, Portal.
  • Environment. Environment to which a purge request applies, either Staging or Production.
  • Responses. Response status, class (0XX-6XX) or code for the purge request.

Details views

  • Support ID. Unique identifier for a purge request.
  • Object details view.
  • Request Object. String search for object present in a purge request.
  • CP code. Content provider (CP) code to which purge object belongs.

Metrics

Requests view. Summary of metrics based on selected filters:

  • Requests Total. Total number of purge requests.
  • Objects Total. Total number of purge objects.
  • Usage summary. Purge requests and objects in time.
  • Usage by client name. Purge requests and objects by client name.
  • Requests by action. Purge requests and objects by action applied.
  • Requests by type. Purge requests and objects by type.
  • Requests by source. Purge requests and objects by source.
  • Requests by environment. Purge requests and objects by environment.
  • Requests by response. Purge requests and objects by response code.
  • Requests by response class. Purge requests and objects by response class.

Requests details view:

  • Date/time. Exact timestamp of request received.
  • Support ID. Unique identifier for a purge request.
  • Client owner. Externally visible customer username associated with a purge request. It's an owner of API client for an open normal client, or a unique identifier for a service account client.
  • Client ID. Unique identifier assigned to an API client. This would point to the client owner when account switching is enabled.
  • Client IP. IP address of host machine on which a purge request was initiated.
  • Authorization Client Token. Unique edgegrid authorization token assigned to an API client.
  • Request action. Purge action desired on request object: Delete, Invalidate.
  • Request type. Type associated to request object: ARL, CP code, Tag, URL, VCD.
  • Request Source. Source of a purge request: EdgeGrid, Portal.
  • Environment. Environment to which a purge request applies, either Staging or Production.
  • Response Code. An HTTP response status code. For example, 403 for purge request.
  • Error title. Underscore delimited title field of response (- indicates there were no errors).

In the Purge Usage (new) report, you can see more data in a CSV file you can download on the Requests details tab. The file shows this additional data:

  • Client name. Name given to an API client by the user who creates it. It is applicable to service accounts.
    Response status. Indicates whether an HTTP request resulted in success or an error.
  • Response class. Class of HTTP response status codes. For example, 2xx.
  • Account ID. Customer account identifier linked to a purge request.
  • Contract type. Contract type identifier associated with a purge request.
  • HTTP method. HTTP request method, either GET or POST.
  • API version. Purge API version.
  • Bad request object. Specific object in a purge request that triggered an error.
  • Elapsed time. Time in milliseconds between receiving a request and writing the last byte of a reply to a client socket.
  • Content length. Content size reported in the Content-Length HTTP request header.
  • Content type. Media format reported in the Content-Type HTTP request header.
  • User agent. User agent reported in the User-Agent HTTP request header.
  • Consumer token hostname. Unique hostname assigned to an API client.
  • Account switching enabled. Indicates whether account switching is enabled.
  • CP code purge enabled. Indicates whether CP code purge is enabled.
  • Tag purge enabled. Indicates whether TAG purge is enabled.
  • CP code count. Number of objects of type CP code.
  • Tag count. Number of objects of type TAG.
  • ARL count. Number of objects of type ARL.
  • Objects count. Number of objects in a purge request.
  • URL count. Number of objects of type URL.

Object details view:

  • Date/time. Exact timestamp of request for given object received.
  • Support ID. Unique identifier for a purge request.
  • Request Object. Object present in a purge request.
  • CP code. Content provider (CP) code to which purge object belongs.
  • Consumer Token Hostname. Unique hostname assigned to an API client.
  • Flexible Cache ID. Indicates whether purge object has a flexible cache ID associated with it.

In the Purge Usage (new) report, you can see more data in a CSV file you can download on the Objects details tab. The file shows this additional data:

  • Client owner. Externally visible customer username associated with a purge request. It's an owner of an API client for an open normal client, or a unique identifier for a service account client.
  • Client name. Name given to an API client by the user who creates it. It is applicable to service accounts.
  • Client ID. Identifier of an API client generating a purge request.
  • Authorization client token. Unique EdgeGrid authorization token assigned to an API client.
  • Request action. Purge action desired on objects in a purge request. For example, Invalidate.
  • Request type. Type of objects in a purge request. For example, ARL.
  • Request source. Source of a purge request. For example, PORTAL.
  • Environment. Environment to which a purge request applies, either PRODUCTION or STAGING.
  • Response status. Indicates whether an HTTP request resulted in success or an error.
  • Response class. Class of HTTP response status codes. For example, 2xx.
  • Response code. An HTTP response status code. For example, 403.
  • Account ID. Customer account identifier linked to a purge request.
  • Contract type. Contract type identifier associated with a purge request.

Updated about 22 hours ago