Global Traffic Management Reporting API Data

This section provides you with the data model for the Traffic Management Reporting API.

Schemas

DataCenter

This object provides reports for data centers, broken down by timestamp, datacenterId, or property, at five-minute granularity.

Sample GET:

{
    "datacenters": [
        {
            "errorCode": 3101,
            "testName": "Our defences",
            "agentIp": "204.1.136.239",
            "datacenterId": 3202,
            "targetIp": "1.2.3.5",
            "duration": 0,
            "nickname": "Krak\u00f3w office"
        }
    ]
}

DataCenter Members  

Member Type Required Description
IPs DataCenter.IPs[n] Container for each server IP in the data center.
agentIp String IP address of the server monitor agent that encountered the error.
currentLoad Number Current load for a resource.
datacenterId Integer Unique identifier for each data center.
duration Integer Duration of the error in seconds.
errorCode Integer Integer ID of the Error.
maximumLoad Number Maximum load for a resource.
nickname String Nickname of the data center.
percentActual Number Percentage of actual demand for a resource.
percentProvisioned Number Percentage of provisioned demand for a resource.
requests Integer Number of DNS requests.
targetIp String IP address of the target server.
targetLoad Number Target load for a resource.
testName String Name of liveness test.

DataCenter.IPs[n]  

Container for each server IP in the data center.

Member Type Required Description
alive Boolean True when the server is considered as alive.
handedOut Boolean True when the server has been handed out.
ip String IP address of the server.
score Number Server score based on liveness tests.

Metadata

This object contains the API request data for URL and query parameters.

Sample GET:

{
    "metadata": {
        "start": "2015-08-31T15:05:00Z",
        "domain": "example.akadns.net",
        "end": "2015-08-31T15:10:00Z",
        "uri": "http://localhost:9090/gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters/3200?start=2015-08-31T15:05:00Z&end=2015-08-31T15:10:00Z",
        "datacenter": "3200"
    }
}

Metadata Members  

Member Type Required Description
agentIp String IP address of the server monitor agent that encountered the error.
datacenterId Integer Integer ID of the data center.
datacenterNickname String Nickname of the data center.
date String Date of report, in ISO 8601 format of YYYY-MM-DD.
domain String Name of the Traffic Management domain.
end String End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
interval Enumeration Value of time for report granularity in seconds. Possible enum values: FIVE_MINUTE.
ip String IP Address of the server.
latency String Latency in milliseconds, formatted to supplied bucket schema.
loss String Percentage loss, formatted to supplied bucket schema.
mostRecent Boolean Fetch the most recent update.
property String Name of Traffic Management property.
region Integer Region or data center ID.
resource String Name of the resource.
start String Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
targetIp String IP address of the test target.
uri String URL of the API call.

Error

This object provides details for error codes and their descriptions.

Sample GET:

{
    "items": [
        {
            "errorCode": 3082,
            "errorDescription": "Attempting to link in too many shared libraries"
        }
    ]
}

Error Members  

Member Type Required Description
errorCode Integer Integer ID of the error.
errorDescription String Error message when requests for reports fails.

Last modified: 6/2/2017