Akamai

Akamai: Global Traffic Management Reporting API

Get read-only reports on Global Traffic Management's real-time statistics.

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

Get read-only reports on Global Traffic Management's
real-time statistics.

Endpoints 24

Domains

  • GETGet a domain list/domain-list?accountSwitchKey=1-5C0YLB:1-8BYUXThis operation retrieves a list of domains, along with a URL templated link to obtain a domain summary of associated properties and data centers for each.
  • GETList domain names for an account and contract type/domain-list/accounts/:accountId/contract-types/:contractTypeId/domain-names?accountSwitchKey=1-5C0YLB:1-8BYUXReturns a list of GTM domain names accessible to the current user for the given account and contract type.
  • GETList domain names/domain-list/domain-names?accountSwitchKey=1-5C0YLB:1-8BYUXReturns a list of GTM domain names accessible to the current user.
  • GETGet a domain summary/domain-list/:domain?accountSwitchKey=1-5C0YLB:1-8BYUXThis operation retrieves a list of property names, as well as Datacenter names and IDs for a given domain.

Traffic

  • GETGet a datacenter traffic report window/traffic/datacenters-window?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the date range of data available for datacenter traffic reports. Use the returned start and end values as the bounds for queries to the datacenter…
  • GETReport traffic per data center/traffic/domains/:domain/datacenters/:datacenterId?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXThis report shows, for a given domain and data center, the DNS requests received in each five-minute period. Requests are broken down by property.
  • GETReport traffic per property/traffic/domains/:domain/properties/:property?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXThis report shows, for a given domain and property, the DNS requests received in each five-minute period. Requests are broken down by data center.
  • GETGet a property traffic report window/traffic/properties-window?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the date range of data available for property traffic reports. Use the returned start and end values as the bounds for queries to the property traffic…

Liveness

  • GETReport liveness per property/liveness-tests/domains/:domain/properties/:property?date=2021-08-31&agentIp=192.0.2.213&targetIp=192.0.2.2&accountSwitchKey=1-5C0YLB:1-8BYUXThis operation returns a collection of reports containing logs of individual liveness tests which have failed. Liveness Tests are run periodically by Web…
  • GETList liveness test errors/liveness-tests/error-code-descriptions?accountSwitchKey=1-5C0YLB:1-8BYUXThis operation lists all the possible liveness test error codes (as displayed on the Liveness Test Failures report) and a description of each error.
  • GETGet a Liveness Test error/liveness-tests/error-code-descriptions/:errorCode?accountSwitchKey=1-5C0YLB:1-8BYUXThis operation returns an error description for the given Liveness Test error ID.
  • GETGet a liveness test report window/liveness-tests/window?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the date range of data available for liveness test reports. Use the returned start and end values as the bounds for queries to the liveness test…

Directed demand

  • GETReport directed demand for a property/demand/domains/:domain/properties/:property?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXThe requests generated by the client machines behind a client name-server represent demand. This API returns a collection of reports containing the…
  • GETGet a directed demand report window/demand/domains/:domain/properties/:property/window?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the date range of data available for directed demand reports. Use the returned start and end values as the bounds for queries to the directed demand…

Load feedback

  • GETGet most recent load feedback data/load-feedback/domains/:domain/most-recent-load-data?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the most recent load feedback values reported by each data center for the given domain. This provides a snapshot of the current load state across all…
  • GETReport load feedback/load-feedback/domains/:domain/resources/:resource?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXThis report shows the historical values of a given Resource across all data centers and the given time period. A resource is anything that can constrain the…
  • GETGet a load feedback report window/load-feedback/domains/:domain/window?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the date range of data available for load feedback reports. Use the returned start and end values as the bounds for queries to the load feedback…

Latency

  • GETReport latency per data center/latency/domains/:domain/datacenters/:datacenterId?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&latency=0|100|200|1000&loss=0|10|20|100&accountSwitchKey=1-5C0YLB:1-8BYUXThis operation returns a collection of reports representing latency and loss of ping data as reported by network agents in each Data Center for a property.…

IP availability

  • GETList IP availability per property/ip-availability/domains/:domain/properties/:property?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&ip=192.0.2.153&mostRecent=false&datacenterId=3132&accountSwitchKey=1-5C0YLB:1-8BYUXGTM combines scores (based on Liveness Tests) from all Web agents to calculate Server Scores and makes liveness decisions. A cutoff value is computed for each…

Diagnostics

  • GETReport datacenter diagnostics/diagnostics/datacenter/domains/:domain?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns diagnostic data showing how traffic from autonomous systems and countries is being distributed across datacenters for the given domain and time period.
  • GETReport IP diagnostics/diagnostics/ip/domains/:domain/properties/:property?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&ip=192.0.2.1&accountSwitchKey=1-5C0YLB:1-8BYUXReturns diagnostic data showing the per-name server mapping decisions made by GTM for the given domain, property, IP address, and time period. Includes…
  • GETReport map diff diagnostics/diagnostics/mapdiff/domains/:domain?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns a diff of traffic distribution map snapshots for the given domain and time period, showing how AS and country-to-datacenter mappings changed between…
  • GETReport detailed map diff diagnostics for a data center and AS/diagnostics/mapdiff/domains/:domain/datacenters/:datacenterId/as/:asNumber?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns detailed geo and ping score time series for the given domain, datacenter, and autonomous system over the specified time period.
  • GETReport detailed map diff diagnostics for a data center and country/diagnostics/mapdiff/domains/:domain/datacenters/:datacenterId/countries/:countryCode?start=2021-05-23T01:56:13Z&end=2021-05-24T01:56:13Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns detailed geo and ping score time series for the given domain, datacenter, and country over the specified time period.

API details

Base URL
https://{hostname}/gtm-api/v1/reports
Authentication
None declared in the description
Operations
24 operations on 24 pathsGET 24
Main resources
Diagnostics 5Domains 4Liveness 4Traffic 4Load feedback 3Directed demand 2IP availability 1Latency 1
Response formats
application/json text/csv
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Global Traffic Management 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: Global Traffic Management 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 “Get a domain list” (GET /domain-list?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: Global Traffic Management Reporting API?

Get read-only reports on Global Traffic Management's real-time statistics. It is listed under Developer tools and has 24 endpoints.

Who publishes the Akamai: Global Traffic Management 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: Global Traffic Management Reporting API?

Requests go to https://{hostname}/gtm-api/v1/reports. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Global Traffic Management 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: Global Traffic Management Reporting API have?

24 operations on 24 paths (24 GET). The largest groups are Diagnostics, Domains, Liveness, Traffic.

Is forking the Akamai: Global Traffic Management 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.