Akamai

Akamai: Reporting API

Generate custom reports to monitor and optimize your Akamai services.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Generate custom reports to monitor and optimize your Akamai services.

Endpoints 6

Report list

  • GETList reports/reports?accountSwitchKey=1-5C0YLB:1-8BYUXReturns all available reports.
  • GETList reports per product family/reports/:productFamily?accountSwitchKey=1-5C0YLB:1-8BYUXReturns all available reports for a product family.
  • GETList reports per reporting area/reports/:productFamily/:reportingArea?accountSwitchKey=1-5C0YLB:1-8BYUXReturns all available reports for a product family and reporting area.

Report metadata

  • GETGet report options/reports/:productFamily/:reportingArea/:report?accountSwitchKey=1-5C0YLB:1-8BYUXReturns available options to generate the report.

Report data

  • POSTGenerate a report/reports/:productFamily/:reportingArea/:report/data?start=2024-06-02T00:00:00Z&end=2024-06-02T00:00:00Z&timeRange=LAST_1_HOUR&async=true&pageSize=1000&accountSwitchKey=1-5C0YLB:1-8BYUXProduces a report in either JSON or CSV format.
  • GETGet asynchronous report results/reports/:productFamily/:reportingArea/:report/queries/:queryId?accountSwitchKey=1-5C0YLB:1-8BYUXProduces a report for an asynchronous request in either JSON or CSV format.

API details

Base URL
https://{hostname}/reporting-api/v2
Authentication
None declared in the description
Operations
6 operations on 6 pathsGET 5POST 1
Main resources
Report list 3Report data 2Report metadata 1
Response formats
application/json application/problem+json text/csv
Description format
OpenAPI 3.0.0, API version v2

How to test the Akamai: Reporting API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Reporting API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List reports” (GET /reports?accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Reporting API?

Generate custom reports to monitor and optimize your Akamai services. It is listed under Developer tools and has 6 endpoints.

Who publishes the Akamai: Reporting API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Reporting API?

Requests go to https://{hostname}/reporting-api/v2. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Reporting API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Reporting API have?

6 operations on 6 paths (5 GET, 1 POST). The largest groups are Report list, Report data, Report metadata.

Is forking the Akamai: Reporting API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.