Create a delivery configuration and deliver content
You need at least one of the products covered by Media Delivery Reports added to your contract. You need a delivery configuration set up for the product, and it needs to be actively delivering content. Active media delivery products include:
This API also offers reports for legacy delivery products, including HTTP Content Delivery, HTTP Downloads/File Downloads, Object Caching, and RTMP Media Delivery. These products aren't available for new configurations, but you can view delivery report data for existing configurations.
Get access and credentials
You'll need access to various services and credentials to use this API:
-
You need different permissions to access API functions. You can manage permissions in Control Center. Learn more about the access control model.
-
You need authentication credentials. Use Akamai's Identity and Access Management tool to create these credentials. You'll need these API services included in the credential:
-
Media Delivery Reports. Verify you have the API service named Media Delivery Reports in the Identity and Access Management tool, and its access level is set to READ-ONLY.
-
Property Manager API (PAPI). This is optional but recommended. You can call PAPI to get some of the parameters you need to include in calls to this API. Verify you have the API service named Property Manager in the Identity and Access Management tool, and its access level is set to READ-WRITE.
-
Get your CP code
A Content Provider (CP) code is a unique identifier that Akamai uses for reporting, billing, and monitoring traffic served over the edge network. This is how you'll filter delivery information for report output with this API. Prior to delivering your content, you'll set up a delivery configuration ("property") using Property Manager for your selected media delivery product. During this setup, you'll create a CP code:
- You enter a unique, easy-to-recognize name. This is your "CP code name."
- Akamai generates an alphanumeric value and assigns it to your CP code name. This is your actual "CP code."
Several of the operations in this API require your CP code. Click the recipe below to run a PAPI operation to get it. Look for the applicable one in the response, based on your CP code name (cpcodeName
). Store the cpcodeId
value, minus the cpc_
prefix.
About the code examples in this documentation
The code examples shown in this API documentation are intended for reference but don't contain the required authentication code syntax you need to make API calls. To learn how to apply authentication in a variety of programming languages when using Akamai APIs, refer to Authenticate with EdgeGrid.
Provide feedback or ask a question in the Akamai Developer Discussion Forum. You can also contact your Akamai account representative for support. We want to hear from you!