API

Gather data to execute the report

Each report allows a different range of request options, so first you need to gather all the information you'll need to execute it:

  1. Gather a list of CP codes for which you want to report data.

  2. Run the List report types operation. Optionally specify showDeprecated=false to narrow the results to the latest available version. Set showUnavailable=false to omit any reports that your API client's identity can't execute.

    If you want to view other reports not available under your product, set showUnavailable=true, but note that you can't execute any report unless it is marked as available. While you can execute many reports under any Akamai product, some require specific sets of products to enable them. If a report is unexpectedly not available, make sure you're executing the report with access to any of the requiredProducts specified. Also make sure the API client identity has any of the permissions specified in requiredRoles.

  3. Optionally store any object from the List report types operation's response array and store its name and version values. Otherwise use those values to run the Get a report type operation, storing its response object, which includes most of the data you need to execute the report.

  4. From the report type object's metrics array, store an array of each metric name you want to include in the report. The accompanying fullDescription provides documentation for each metric.

  5. From the filters array, store an object mapping of each filter name you want to refine results with. Make sure to include any filters that are required. The accompanying fullDescription provides documentation for each filter.

  6. For each filter name key you include in the map, the value needs to be an array. If the filter type is int or string, specify whatever set of values you want to refine the report. If the type is enum, then for each object in values, include any available value in the array. An accompanying fullDescription may clarify its use.

  7. The intervals array specifies a set of duration values, available for each report, to aggregate each row of data. Select a value to later pass in as the interval query parameter.

  8. Specify an overall time span for the entire report as start and end parameter values. But note that there may be a maxLimit cap on the number of data rows in each report. If the interval value is too brief, the report may fail to execute.

📘

The start and end parameters must be rounded to the time interval you're using. For example, you can set the time range of 15 minutes for the FIVE_MINUTES interval, or the time range of 3 hours for the HOUR interval.