Qodex.ai

Reporting API v2

Number of APIs: 6

Use the Reporting API v2 to analyze data about Akamai products and your business on the web. With this API, you can monitor traffic, analyze patterns and long-term trends, compile information, forecast capacity, or detect anomalies.

In a single API call, you can select metrics you want to include in your report and group them by various dimensions, such as CP codes or hostnames. This lets you dynamically specify your data retrieval parameters and offers greater control over the extraction and analysis process.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

  1. Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

    Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

  2. Click Quick and then Download in the Credentials section.

    Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

  3. Open the downloaded file with a text editor and add [default] as a header above all text.

     [default]
 client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
 host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
 access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
 client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

  4. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

To enable this API, choose the API service named Reporting API, and set the access level to READ-WRITE.

Integration methods

You can use this API collection in these integration methods:

  1. Report list - List reports per product family GET https://{{host}}/reporting-api/v2/reports/:productFamily

  2. Report data - Generate a report POST https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report/data

  3. Report metadata - Get report options GET https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report

  4. Report list - List reports GET https://{{host}}/reporting-api/v2/reports

  5. Report list - List reports per reporting area GET https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea

  6. Report data - Get asynchronous report results GET https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report/queries/:queryId