The Global Traffic Management Reporting API

The Traffic Management Reporting API provides read-only reports on GTM’s real time statistics. Each call allows you to view traffic, liveness, direct demand, load feedback, and latency on datacenters and properties.

Who Should Use This API

This API is for site administrators, project managers, technical support providers, and others who implement traffic management reporting for your organization. It assumes that you have a working knowledge of traffic management reporting and GTM.

Getting Started

Before using the Beta API for the first time:

  • During the Beta period, contact your Akamai representative to enable the API for your account.

  • Review the OPEN API Introduction on tools that Akamai provides.

  • Review OPEN API Provisioning to create your OPEN API access credentials and authorizations, making sure you enable read access for the Traffic Management Reporting API. As detailed in API Identity Model, you then access the API using custom hostnames that looks like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

  • If you need help, provide feedback with the {OPEN} developer community, or else contact your Akamai representative for support.

Dual Format Responses

Operations for the API produces either JSON or CSV, depending on the value of the Accept header sent as part of the request.

Concepts

This section provides a road map of all the conceptual objects you deal with when interacting with GTM reports, and provides pointers to where you can learn more.

  • Domain: A Traffic Management domain is a domain with one or more subdomains that share a number of attributes that can only be configured domain-wide. These attributes include use of load imbalance factor, the set of available data centers, etc. Each Domain object is a representation of a complete GTM domain (e.g., example.akadns.net)

  • Property: Representation of GTM property, (e.g., www) which in DNS terms is a subdomain of the domain. Combined with its domain (e.g., example.akadns.net), the fully qualified domain name www.example.akadns.net is used for load balancing.

  • Datacenter: A group of colocated servers that are load balanced as a unit.

  • Resource: An abstract entity that constrains the load on the properties that it governs. The goal of resources is to encapsulate the architecture and topology of the network in a data center. For example, each property normally has an associated resource that represents the capacity of the servers for that property. In addition, there might be a resource that constrains the aggregate bandwidth available to all properties in a data center.

Please refer to the Global Traffic Management User Guide for additional information.


Last modified: 6/2/2017