Global Traffic Management Reporting API Resources

The Traffic Management Reporting API allows you to view reports for GTM statistics.

API Summary

Operation Method Endpoint
Reports   (download RAML)
Get a Domain List GET /gtm-api/v1/reports/domain-list
Get a Domain Summary GET /gtm-api/v1/reports/domain-list/{domain}
Report Directed Demand for a Property GET /gtm-api/v1/reports/demand/domains/{domain}/properties/{property}{?end,start}
List IP Availability per Property GET /gtm-api/v1/reports/ip-availability/domains/{domain}/properties/{property}{?datacenterId,end,ip,mostRecent,start}
Report Latency per Data Center GET /gtm-api/v1/reports/latency/domains/{domain}/datacenters/{datacenterId}{?end,start,latency,loss}
Report Liveness per Property GET /gtm-api/v1/reports/liveness-tests/domains/{domain}/properties/{property}{?date,agentIp,targetIp}
List Liveness Test Errors GET /gtm-api/v1/reports/liveness-tests/error-code-descriptions
Get a Liveness Test Error GET /gtm-api/v1/reports/liveness-tests/error-code-descriptions/{errorCode}
Report Load Feedback GET /gtm-api/v1/reports/load-feedback/domains/{domain}/resources/{resource}{?end,start}
Report Traffic per Data Center GET /gtm-api/v1/reports/traffic/domains/{domain}/datacenters/{datacenterId}{?end,start}
Report Traffic per Property GET /gtm-api/v1/reports/traffic/domains/{domain}/properties/{property}{?end,start}

Get a Domain List

This operation retrieves a list of domains, along with a URL templated link to obtain a domain summary of associated properties and datacenters for each.

GET /gtm-api/v1/reports/domain-list

Status 200 application/json

Response Body:

{
    "domains": [
        "example.akadns.net",
        "more-examples.akadns.net"
    ],
    "links": [
        {
            "href": "http://localhost:9090/gtm-api/v1/reports/domain-list/",
            "rel": "self"
        },
        {
            "href": "http://localhost:9090/gtm-api/v1/reports/domain-list/{domain}",
            "rel": "domain"
        }
    ]
}

Get a Domain Summary

This operation retrieves a list of property names, as well as Datacenter names and IDs for a given domain.

GET /gtm-api/v1/reports/domain-list/{domain}

Sample: /gtm-api/v1/reports/domain-list/example.akadns.net

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response Body:

{
    "datacenters": [
        {
            "datacenterId": 3132,
            "datacenterNickname": "Winterfell"
        },
        {
            "datacenterId": 3133,
            "datacenterNickname": "Braavos"
        }
    ],
    "name": "example.akadns.net",
    "resources": [
        "cpu",
        "disk"
    ],
    "properties": [
        "www",
        "db"
    ]
}

Report Directed Demand for a Property

The requests generated by the client machines behind a client name-server represent demand. This API returns a collection of reports containing the provisioned demand percentage vs actual demand percentage seen by GTM rounded off to nearest 5 min interval for each data center. This API returns no data for load feedback-based domains, as those domains do not have a configured per data center load.

GET /gtm-api/v1/reports/demand/domains/{domain}/properties/{property}{?end,start}

Sample: /gtm-api/v1/reports/demand/domains/example.akadns.net/properties/www?end=2016–05–24T01%3A56%3A13Z&start=2016–05–23T01%3A56%3A13Z

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
property String www Name of Traffic Management Property.
Required Query Parameters
end String 2016-05-24T01:56:13Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
start String 2016-05-23T01:56:13Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Status 200 application/json

Response Body:

{
    "metadata": {
        "start": "2017-02-14T14:51:27Z",
        "domain": "example.akadns.net",
        "property": "www",
        "end": "2017-02-14T18:51:27Z",
        "uri": "http://localhost:9090/gtm-api/v1/reports/demand/domains/example.akadns.net/properties/cp140238?start=2017-02-14T14:51:27Z&end=2017-02-14T18:51:27Z"
    },
    "links": [
        {
            "href": "http://localhost:9090/gtm-api/v1/reports/demand/domains/example.akadns.net/properties/cp140238?start=2017-02-14T14:51:27Z&end=2017-02-14T18:51:27Z",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2017-02-14T14:51:27Z",
            "datacenters": [
                {
                    "datacenterId": 3200,
                    "percentActual": 50.0,
                    "nickname": "Winterfell",
                    "percentProvisioned": 12.0,
                    "trafficTargetName": "Winterfell - 1.2.3.4"
                },
                {
                    "datacenterId": 3201,
                    "percentActual": 50.0,
                    "nickname": "Braavos",
                    "percentProvisioned": 88.0,
                    "trafficTargetName": "Braavos - 1.2.3.5"
                }
            ]
        },
        {
            "timestamp": "2017-02-14T15:01:27Z",
            "datacenters": [
                {
                    "datacenterId": 3200,
                    "percentActual": 50.0,
                    "nickname": "Winterfell",
                    "percentProvisioned": 12.0,
                    "trafficTargetName": "Winterfell - 1.2.3.4"
                },
                {
                    "datacenterId": 3201,
                    "percentActual": 50.0,
                    "nickname": "Braavos",
                    "percentProvisioned": 88.0,
                    "trafficTargetName": "Braavos - 1.2.3.5"
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"domain","property","timestamp","datacenterId","datacenterNickname","trafficTargetName","percentProvisioned","percentActual"
"example.akadns.net","www","2017-02-25T14:34:10Z","3200","Winterfell","Winterfell - 1.2.3.4","12.0","50.0"
"example.akadns.net","www","2017-02-25T14:34:10Z","3201","Braavos","Braavos - 1.2.3.5","88.0","50.0"
"example.akadns.net","www","2017-02-25T14:44:10Z","3200","Winterfell","Winterfell - 1.2.3.4","12.0","50.0"
"example.akadns.net","www","2017-02-25T14:44:10Z","3201","Braavos","Braavos - 1.2.3.5","88.0","50.0"

List IP Availability per Property

GTM 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 property from the median scores for all the servers in the property. Any property server with a score over the cutoff value is considered dead and it won’t be handed out. The request should have either start and end time or mostRecent, and not both.

In the response, handOut indicates whether the server was handed out and alive indicates whether GTM considered the server as alive or not.

GET /gtm-api/v1/reports/ip-availability/domains/{domain}/properties/{property}{?datacenterId,end,ip,mostRecent,start}

Sample: /gtm-api/v1/reports/ip-availability/domains/example.akadns.net/properties/www?datacenterId=3132&end=2016–11–17T18%3A20%3A36Z&ip=1.2.3.4&mostRecent=true&start=2016–11–16T18%3A20%3A36Z

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
property String www Name of Traffic Management property.
Optional Query Parameters
datacenterId Integer 3132 Data center ID.
end String 2016-11-17T18:20:36Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
ip String 1.2.3.4 IP address of the server.
mostRecent Boolean true Most recent update.
start String 2016-11-16T18:20:36Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Status 200 application/json

Response Body:

{
    "metadata": {
        "domain": "example.akadns.net",
        "property": "www",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/ip-availability/domains/example.akadns.net/properties/www"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/ip-availability/domains/example.akadns.net/properties/www",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2017-02-23T21:42:35Z",
            "cutOff": 112.5,
            "datacenters": [
                {
                    "datacenterId": 3132,
                    "nickname": "Winterfell",
                    "trafficTargetName": "Winterfell - 1.2.3.4",
                    "IPs": [
                        {
                            "ip": "1.2.3.4",
                            "score": 75.0,
                            "handedOut": true,
                            "alive": true
                        }
                    ]
                },
                {
                    "datacenterId": 3133,
                    "nickname": "Braavos",
                    "trafficTargetName": "Braavos - 1.2.3.5",
                    "IPs": [
                        {
                            "ip": "1.2.3.5",
                            "score": 85.0,
                            "handedOut": true,
                            "alive": true
                        }
                    ]
                }
            ]
        },
        {
            "timestamp": "2017-03-23T21:42:35Z",
            "cutOff": 112.5,
            "datacenters": [
                {
                    "datacenterId": 3132,
                    "nickname": "Winterfell",
                    "trafficTargetName": "Winterfell - 1.2.3.4",
                    "IPs": [
                        {
                            "ip": "1.2.3.4",
                            "score": 115.0,
                            "handedOut": false,
                            "alive": false
                        }
                    ]
                },
                {
                    "datacenterId": 3133,
                    "nickname": "Braavos",
                    "trafficTargetName": "Braavos - 1.2.3.5",
                    "IPs": [
                        {
                            "ip": "1.2.3.5",
                            "score": 75.0,
                            "handedOut": true,
                            "alive": true
                        }
                    ]
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"timestamp","domain","property","datacenterId","datacenterNickname","ip","score","cutOff","handOut","alive"
"2017-02-23T21:42:35Z","example.akadns.net","www","3200","Winterfell","Winterfell - 1.2.3.4","1.2.3.4","75.0","112.5","true","true"
"2017-02-23T21:42:35Z","example.akadns.net","www","3133","Braavos","Braavos - 1.2.3.5","1.2.3.5","85.0","112.5","true","true"
"2017-03-23T21:42:35Z","example.akadns.net","www","3200","Winterfell","Winterfell - 1.2.3.4","1.2.3.4","115.0","112.5","false","false"
"2017-03-28T21:42:35Z","example.akadns.net","www","3133","Braavos","Braavos - 1.2.3.5","1.2.3.5","75.0","112.5","true","true"

Report Latency per Data Center

This 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. Latency and Loss parameters follow bucket ranges schema (bucket ranges, delimited by a pipe: |).

Ping Loss ranges from 0% to 100%. So a schema of 5|10|15|20 would represent grouping of data from 0% to 5%, 5% to 10%, 10% to 15%, 15% to 20%, and 20% to 100% bucket ranges. The end of one bucket would be the beginning of the next bucket. Similarly 0|5|80 would represent 0%, 0% to 5%, 5% to 100%, and 80% to 100% bucket ranges. A trailing pipe at the end of a bucket indicates that there is no greater than the max bucket, i.e. in the above example if loss schema was 0|5|80| then it would mean 0%, 0% to 5%, and 5% to 80%.

Latency is measured in milliseconds. Each bucket ranges from 0 ms to 1000 ms. So, a schema of 5|10|300|1000 would mean 0ms to 5ms, 5ms to 10ms, 10ms to 300ms, 300ms to 1000ms, and > 1000ms.

GET /gtm-api/v1/reports/latency/domains/{domain}/datacenters/{datacenterId}{?end,start,latency,loss}

Sample: /gtm-api/v1/reports/latency/domains/example.akadns.net/datacenters/3200?end=2016–05–24T01%3A56%3A13Z&start=2016–05–23T01%3A56%3A13Z&latency=0%7C100%7C200%7C1000&loss=0%7C10%7C20%7C100

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of the Traffic Management domain.
datacenterId Integer 3200 ID of the data center.
Required Query Parameters
end String 2016-05-24T01:56:13Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
start String 2016-05-23T01:56:13Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
Optional Query Parameters
latency String 0|100|200|1000 Latency Bucket Schema.
loss String 0|10|20|100 Loss Bucket Schema.

Status 200 application/json

Response Body:

{
    "metadata": {
        "loss": "0|100",
        "domain": "example.akadns.net",
        "end": "2017-02-14T18:11:26Z",
        "latency": "0|1000",
        "datacenterNickname": "Winterfell",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/latency/domains/example.akadns.net/datacenters/14762?start=2017-02-14T17:11:26Z&end=2017-02-14T18:11:26Z&latency=0%7C1000&loss=0%7C100",
        "datacenterId": 3200,
        "start": "2017-02-14T17:11:26Z"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/latency/domains/example.akadns.net/datacenters/14762?start=2017-02-14T17:11:26Z&end=2017-02-14T18:11:26Z&latency=0%7C1000&loss=0%7C100",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T17:11:26Z"
        },
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T17:21:30Z"
        },
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T17:31:31Z"
        },
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T17:41:27Z"
        },
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T17:51:30Z"
        },
        {
            "latency": [
                0,
                100,
                0
            ],
            "loss": [
                100,
                0,
                0
            ],
            "timestamp": "2017-02-14T18:01:27Z"
        }
    ]
}

Status 200 text/csv

Response Body:

"domain","datacenterId","datacenterNickname","timestamp","latency","loss"
"example.akadns.net","3200","Winterfell","2017-02-25T14:24:07Z","[0, 100, 0]","[97, 3, 0]"
"example.akadns.net","3200","Winterfell","2017-02-25T14:34:10Z","[0, 100, 0]","[97, 3, 0]"

Report Liveness per Property

This operation returns a collection of reports containing logs of individual liveness tests which have failed. Liveness Tests are run periodically by Web Agents installed in customer data centers. Liveness scores are used by GTM to decide whether a data center is alive or not.

Liveness tests which fail in succession (tests that run from the same testing agent to the same origin server, which fail with the same error code) are grouped together and represented with a duration. This duration value is in seconds and can sustain for up to 86400 seconds (one day). If it crosses that boundary, GTM logs it as a new failure at the beginning of the next day (00:00 UTC), with the duration reset to that point.

GET /gtm-api/v1/reports/liveness-tests/domains/{domain}/properties/{property}{?date,agentIp,targetIp}

Sample: /gtm-api/v1/reports/liveness-tests/domains/example.akadns.net/properties/www?date=2015–08–31&agentIp=209.170.75.251&targetIp=192.0.2.2

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
property String www Name of Traffic Management property.
Required Query Parameters
date String 2015-08-31 Date of report, in ISO 8601 format of YYYY-MM-DD.
Optional Query Parameters
agentIp String 209.170.75.251 Filter results by Agent IP.
targetIp String 192.0.2.2 Filter results by Target IP.

Status 200 application/json

Response Body:

{
    "metadata": {
        "date": "2016-11-23",
        "domain": "example.akadns.net",
        "property": "www",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/liveness-tests/domains/example.akadns.net/properties/www?date=2016-11-23"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/liveness-tests/domains/example.akadns.net/properties/www?date=2016-11-23",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2016-11-23T00:13:23Z",
            "datacenters": [
                {
                    "datacenterId": 3201,
                    "nickname": "Winterfell",
                    "testName": "Our defences",
                    "agentIp": "204.1.136.239",
                    "errorCode": 3101,
                    "duration": 0,
                    "targetIp": "1.2.3.4",
                    "trafficTargetName": "Winterfell - 1.2.3.4"
                }
            ]
        },
        {
            "timestamp": "2016-11-23T00:15:13Z",
            "datacenters": [
                {
                    "datacenterId": 3202,
                    "nickname": "Braavos",
                    "testName": "Our defences",
                    "agentIp": "204.1.136.239",
                    "errorCode": 3101,
                    "duration": 0,
                    "targetIp": "1.2.3.5",
                    "trafficTargetName": "Braavos - 1.2.3.5"
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"domain","property","timestamp","datacenterId","datacenterNickname","trafficTargetName","targetIp","agentIp","testName","duration","errorCode"
"example.akadns.net","www","2016-12-04T01:57:21Z","3200","Winterfell","Winterfell - 1.2.3.4","1.2.3.4","80.67.75.14","Our defences","3110"
"example.akadns.net","www","2016-12-04T01:57:53Z","3201","Braavos","1.2.3.5","80.67.75.14","Our defences","3100"
"example.akadns.net","www","2016-12-04T01:59:05Z","3200","Winterfell","Winterfell - 1.2.3.4","1.2.3.4","69.31.121.20","Our defences","3101"
"example.akadns.net","www","2016-12-04T01:59:46Z","3201","Braavos","Braavos - 1.2.3.5","1.2.3.5","65.124.174.194","Our defences","3101"

List Liveness Test Errors

This operation lists all the possible liveness test error codes (as displayed on the Liveness Test Failures report) and a description of each error.

GET /gtm-api/v1/reports/liveness-tests/error-code-descriptions

Status 200 application/json

Response Body:

{
    "items": [
        {
            "errorCode": 3082,
            "errorDescription": "Attempting to link in too many shared libraries"
        },
        {
            "errorCode": 3081,
            "errorDescription": ".lib section in a.out corrupted"
        }
    ]
}

Status 200 text/csv

Response Body:

"errorCode ","errorDescription"
"3082","Attempting to link in too many shared libraries"
"3081",".lib section in a.out corrupted"

Get a Liveness Test Error

This operation returns an Error Description for the given Liveness Test error ID.

GET /gtm-api/v1/reports/liveness-tests/error-code-descriptions/{errorCode}

Sample: /gtm-api/v1/reports/liveness-tests/error-code-descriptions/2200

Parameter Type Sample Description
URL Parameters
errorCode Number 2200 Error identification number.

Status 200 application/json

Response Body:

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

Status 200 text/csv

Response Body:

"errorCode ","errorDescription"
"3082","Attempting to link in too many shared libraries"

Report Load Feedback

This 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 load sent to a data center. Examples of typical resources include bandwidth, CPU load average, database queries per second, or disk operations per second.

GET /gtm-api/v1/reports/load-feedback/domains/{domain}/resources/{resource}{?end,start}

Sample: /gtm-api/v1/reports/load-feedback/domains/example.akadns.net/resources/cpu?end=2016–05–24T01%3A56%3A13Z&start=2016–05–23T01%3A56%3A13Z

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
resource String cpu Name of the resource.
Required Query Parameters
end String 2016-05-24T01:56:13Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
start String 2016-05-23T01:56:13Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Status 200 application/json

Response Body:

{
    "metadata": {
        "resource": "cpu",
        "start": "2017-02-14T01:32:52Z",
        "domain": "example.akadns.net",
        "end": "2017-02-14T01:40:52Z",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/load-feedback/domains/example.akadns.net/resources/cpu?start=2017-02-14T01:32:52Z&end=2017-02-14T01:40:52Z"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/load-feedback/domains/example.akadns.net/resources/cpu?start=2017-02-14T01:32:52Z&end=2017-02-14T01:40:52Z",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2017-02-14T01:32:52Z",
            "datacenters": [
                {
                    "currentLoad": 20,
                    "maximumLoad": 40,
                    "nickname": "Winterfell",
                    "targetLoad": 30,
                    "datacenterId": 3135
                },
                {
                    "currentLoad": 30,
                    "maximumLoad": 40,
                    "nickname": "Bravoos",
                    "targetLoad": 40,
                    "datacenterId": 3139
                },
                {
                    "currentLoad": 10,
                    "maximumLoad": 15,
                    "nickname": "King's Landing",
                    "targetLoad": 10,
                    "datacenterId": 3140
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"domain","resource","timestamp","datacenterId","datacenterNickname","currentLoad","targetLoad","maximumLoad"
"example.akadns.net","cpu","2017-02-25T03:46:51Z","3200","Winterfell","20","30","40"
"example.akadns.net","cpu","2017-02-25T03:46:51Z","3201","Braavos","30","40","40"
"example.akadns.net","cpu","2017-02-25T04:46:51Z","3200","Winterfell","10","30","40"
"example.akadns.net","cpu","2017-02-25T04:46:51Z","3201","Braavos","10","40","40"

Report Traffic per Data Center

This report shows, for a given domain and data center, the DNS requests received in each five-minute period. Requests are broken down by property.

GET /gtm-api/v1/reports/traffic/domains/{domain}/datacenters/{datacenterId}{?end,start}

Sample: /gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters/3200?end=2016–05–24T01%3A56%3A13Z&start=2016–05–23T01%3A56%3A13Z

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
datacenterId Integer 3200 Data center ID.
Required Query Parameters
end String 2016-05-24T01:56:13Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
start String 2016-05-23T01:56:13Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Status 200 application/json

Response Body:

{
    "metadata": {
        "datacenterNickname": "Winterfell",
        "domain": "example.akadns.net",
        "end": "2016-11-23T00:10:00Z",
        "interval": "FIVE_MINUTE",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters?start=2016-11-23T00:00:00Z&end=2016-11-23T00:10:00Z",
        "datacenterId": 3200,
        "start": "2016-11-23T00:00:00Z"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters?start=2016-11-23T00:00:00Z&2016-11-23T00:10:00Z",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2016-11-23T00:00:00Z",
            "properties": [
                {
                    "status": "1",
                    "requests": 45,
                    "name": "www"
                }
            ]
        },
        {
            "timestamp": "2016-11-23T00:05:00Z",
            "properties": [
                {
                    "status": "1",
                    "requests": 45,
                    "name": "www"
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"timestamp","domain","property","datacenterId","datacenterNickname","requests","status"
"2017-03-01T20:30:00Z","example.akadns.net","www","3132","Winterfell","39","1"
"2017-03-01T20:35:00Z","example.akadns.net","www","3132","Winterfell","266","1"

Report Traffic per Property

This report shows, for a given domain and property, the DNS requests received in each five-minute period. Requests are broken down by data center.

GET /gtm-api/v1/reports/traffic/domains/{domain}/properties/{property}{?end,start}

Sample: /gtm-api/v1/reports/traffic/domains/example.akadns.net/properties/www?end=2016–05–24T01%3A56%3A13Z&start=2016–05–23T01%3A56%3A13Z

Parameter Type Sample Description
URL Parameters
domain String example.akadns.net Name of Traffic Management domain.
property String www Name of Traffic Management property.
Required Query Parameters
end String 2016-05-24T01:56:13Z End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.
start String 2016-05-23T01:56:13Z Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Status 200 application/json

Response Body:

{
    "metadata": {
        "domain": "example.akadns.net",
        "end": "2016-11-24T01:50:00Z",
        "interval": "FIVE_MINUTE",
        "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/properties/www?start=2016-11-23T00:00:00Z&2016-11-24T01:50:00Z",
        "start": "2016-11-24T01:40:00Z",
        "property": "www"
    },
    "links": [
        {
            "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/properties/www?start=2016-11-23T00:00:00Z&2016-11-24T01:50:00Z",
            "rel": "self"
        }
    ],
    "dataRows": [
        {
            "timestamp": "2016-11-24T01:40:00Z",
            "datacenters": [
                {
                    "datacenterId": 3130,
                    "status": "1",
                    "requests": 34,
                    "nickname": "Winterfell",
                    "trafficTargetName": "Winterfell - 1.2.3.4"
                }
            ]
        },
        {
            "timestamp": "2016-11-24T01:45:00Z",
            "datacenters": [
                {
                    "datacenterId": 3130,
                    "status": "1",
                    "requests": 45,
                    "nickname": "Winterfell",
                    "trafficTargetName": "Winterfell - 1.2.3.4"
                }
            ]
        }
    ]
}

Status 200 text/csv

Response Body:

"timestamp","domain","property","datacenterId","datacenterNickname","trafficTargetName","requests","status"
"2017-03-01T20:30:00Z","example.akadns.net","www","3132","Winterfell","Winterfell - 1.2.3.4","39","1"
"2017-03-01T20:35:00Z","example.akadns.net","www","3133","Braavos","Braavos - 1.2.3.5","266","1"

Last modified: 6/2/2017