API
TrainingSupportCommunity

API concepts

Familiarize yourself with some of the common terms used in this API:

  • Adaptive Media Delivery Reports. These reports provide an analysis of the delivery of HTTP adaptive streaming formats such as HLS, HDS, Smooth, and MPEG-DASH, from third part origins and Akamai Media Services alike.

  • Download Delivery Reports. These reports provide an analysis of large object delivery. This includes media downloads and progressively downloaded content.

  • Object Delivery Reports. These reports provide an analysis of delivery content such as images, CSS, JavaScript, and other files. It includes files smaller than 100 MB, excluding objects of content type: text/html.

  • Akamai Cloud Embed Reports. These reports provide an analysis of the delivery of cloud hosted content. Akamai Cloud Embed was formerly known as Wholesale Delivery.

  • RTMP Media Delivery Reports. These reports provide monitoring and analysis of traffic, performance, and availability for RTMP-based media delivery streams.

  • HTTP Content Delivery Reports. These provide report services for the HTTP Content Delivery service, including traffic information.

  • HTTP Downloads/File Downloads Reports. These reports provide an analysis of file transfers performed through the HTTP Downloads (File Downloads) application.

  • Object Caching Reports. These reports offer data regarding the objects and the total amount of data held in the Akamai edge cache.

  • Data Store. Each product has a unique report pack that's comprised of one or more data stores. A data store collects dimensions and their supported metrics in a database that you can use to create reports.

  • Dimension. Dimensions are the primary guideline for a specific report. Dimensions include things such as the specific time content was consumed, a specific geographic region for requests, or the Akamai content provider (CP) code assigned to requested content.

  • Metric. Metrics are the individual data objects used to generate report data for a selected dimension. Metrics include things such as hits that resulted in a specific HTTP status code, the number of hits to your origin, or even the volume of content delivered from Akamai edge servers. Each dimension has its own set of metrics you can use to generate a report.

  • Real-time Data. The system derives this data from sample set that are available at a latency of under 15 minutes.

  • Historical Data. Most data for Media Delivery Reports is historic data, extracted over a 24-hour time period. It's available for traffic, performance, availability, request URLs, unique viewers, enhanced proxy protection (for AMD, DD, and OD), and token authentication content protection (for AMD).

  • Content Provider (CP) Code. A CP code is a unique identifier that ​Akamai​ uses for reporting, billing, and monitoring traffic served over the edge network. You'll need this value for several of the calls in this API. See Get your CP Code for details.