{ "components": { "parameters": { "account-id-path": { "description": "The unique identifier for an Akamai account.", "in": "path", "name": "accountId", "required": true, "schema": { "example": "A-CCT3456", "type": "string" }, "x-akamai": { "file-path": "parameters/account-id-path.yaml" } }, "contract-type-id-path": { "description": "The unique identifier for a contract type.", "in": "path", "name": "contractTypeId", "required": true, "schema": { "example": "1-8BYUX", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-type-id-path.yaml" } }, "domain-path": { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } }, "schemas": { "domain-list": { "additionalProperties": false, "properties": { "domains": { "description": "The GTM domain names accessible to the current user.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" } }, "required": [ "domains", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-list.yaml" } }, "domain-names": { "description": "GTM domain names accessible to the current user.", "items": { "minLength": 1, "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/domain-names.yaml" } }, "domain-summary": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers configured for the domain.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "datacenterNickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "datacenterNickname" ], "type": "object" }, "type": "array" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "name": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "properties": { "description": "The GTM property names configured for the domain.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "resources": { "description": "The load-feedback resource names configured for the domain.", "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "name", "properties", "datacenters", "resources", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-summary.yaml" } }, "links": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference" }, "info": { "description": "Get read-only reports on Global Traffic Management's\nreal-time statistics.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Global Traffic Management Reporting API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/demand/domains/{domain}/properties/{property}": { "get": { "description": "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, along with 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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-demand-property" }, "operationId": "get-demand-property", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "datacenters": [ { "datacenterId": 3200, "nickname": "Winterfell", "percentActual": 50, "percentProvisioned": 12, "trafficTargetName": "Winterfell - 1.2.3.4" }, { "datacenterId": 3201, "nickname": "Braavos", "percentActual": 50, "percentProvisioned": 88, "trafficTargetName": "Braavos - 1.2.3.5" } ], "timestamp": "2021-02-14T14:51:27Z" }, { "datacenters": [ { "datacenterId": 3200, "nickname": "Winterfell", "percentActual": 50, "percentProvisioned": 12, "trafficTargetName": "Winterfell - 1.2.3.4" }, { "datacenterId": 3201, "nickname": "Braavos", "percentActual": 50, "percentProvisioned": 88, "trafficTargetName": "Braavos - 1.2.3.5" } ], "timestamp": "2021-02-14T15:01:27Z" } ], "links": [ { "href": "http://localhost:9090/gtm-api/v1/reports/demand/domains/example.akadns.net/properties/cp140238?start=2021-02-14T14:51:27Z&end=2021-02-14T18:51:27Z", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-02-14T18:51:27Z", "property": "www", "start": "2021-02-14T14:51:27Z", "uri": "http://localhost:9090/gtm-api/v1/reports/demand/domains/example.akadns.net/properties/cp140238?start=2021-02-14T14:51:27Z&end=2021-02-14T18:51:27Z" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The demand data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers included in this demand row.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "nickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "percentActual": { "description": "The actual percentage of traffic directed to this data center.", "type": "number" }, "percentProvisioned": { "description": "The provisioned percentage of traffic for this data center.", "type": "number" }, "trafficTargetName": { "description": "The name of the traffic target for this data center.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname", "trafficTargetName", "percentProvisioned", "percentActual" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "property": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "property", "uri", "start", "end" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/demand.yaml" } } }, "text/csv": { "example": "\"domain\",\"property\",\"timestamp\",\"datacenterId\",\"datacenterNickname\",\"trafficTargetName\",\"percentProvisioned\",\"percentActual\"\n\"example.akadns.net\",\"www\",\"2021-02-25T14:34:10Z\",\"3200\",\"Winterfell\",\"Winterfell - 1.2.3.4\",\"12.0\",\"50.0\"\n\"example.akadns.net\",\"www\",\"2021-02-25T14:34:10Z\",\"3201\",\"Braavos\",\"Braavos - 1.2.3.5\",\"88.0\",\"50.0\"\n\"example.akadns.net\",\"www\",\"2021-02-25T14:44:10Z\",\"3200\",\"Winterfell\",\"Winterfell - 1.2.3.4\",\"12.0\",\"50.0\"\n\"example.akadns.net\",\"www\",\"2021-02-25T14:44:10Z\",\"3201\",\"Braavos\",\"Braavos - 1.2.3.5\",\"88.0\",\"50.0\"", "schema": { "type": "string" } } }, "description": "Successful response." } }, "summary": "Report directed demand for a property", "tags": [ "Directed demand" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/property-demand.yaml", "path-info": "/demand/domains/{domain}/properties/{property}" } }, "/demand/domains/{domain}/properties/{property}/window": { "get": { "description": "Returns 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 report endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-demand-window" }, "operationId": "get-demand-window", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "end": "2021-02-23T15:05:00Z", "start": "2021-02-13T00:00:00Z" }, "schema": { "additionalProperties": false, "description": "The time range of data available for a report.", "properties": { "end": { "description": "An ISO 8601 timestamp indicating when the available data ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the available data begins.", "type": "string" } }, "required": [ "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/report-window.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a directed demand report window", "tags": [ "Directed demand" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/demand-window.yaml", "path-info": "/demand/domains/{domain}/properties/{property}/window" } }, "/diagnostics/datacenter/domains/{domain}": { "get": { "description": "Returns diagnostic data showing how traffic from autonomous systems and countries is being distributed across datacenters for the given domain and time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-datacenter" }, "operationId": "get-diagnostics-datacenter", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "autonomousSystem": { "name": "Example ISP", "number": 12345 }, "country": null, "datacenter": { "datacenterId": 3200, "name": "US East" }, "percent": 42.5, "timestamp": "2021-05-23T00:05:00Z", "type": "AS" } ], "dataSummary": {}, "links": [ { "href": "/gtm-api/v1/reports/diagnostics/datacenter/domains/example.akadns.net", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-05-24T00:00:00Z", "start": "2021-05-23T00:00:00Z", "uri": "/gtm-api/v1/reports/diagnostics/datacenter/domains/example.akadns.net" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The diagnostic data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "autonomousSystem": { "additionalProperties": false, "description": "The autonomous system mapped to the datacenter, if `type` is `AS`.", "nullable": true, "properties": { "name": { "description": "The autonomous system name.", "minLength": 1, "type": "string" }, "number": { "description": "The autonomous system number.", "type": "integer" } }, "type": "object" }, "country": { "additionalProperties": false, "description": "The country mapped to the datacenter, if `type` is `COUNTRY`.", "nullable": true, "properties": { "code": { "description": "The two-letter ISO country code.", "minLength": 1, "type": "string" }, "continentCode": { "description": "The two-letter continent code, either `AF` (Africa), `AN` (Antarctica), `AS` (Asia), `EU` (Europe), `NA` (North America), `OC` (Oceania), or `SA` (South America). `null` if unknown.", "enum": [ "AF", "AN", "AS", "EU", "NA", "OC", "SA" ], "nullable": true, "type": "string" }, "name": { "description": "The full country name.", "minLength": 1, "type": "string" } }, "type": "object" }, "datacenter": { "additionalProperties": false, "description": "The datacenter associated with this row.", "nullable": true, "properties": { "datacenterId": { "description": "The datacenter ID.", "type": "integer" }, "name": { "description": "The datacenter nickname.", "minLength": 1, "type": "string" } }, "type": "object" }, "percent": { "description": "The percentage of traffic mapped to this datacenter from this AS or country.", "type": "number" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" }, "type": { "description": "Whether this row represents an autonomous system (`AS`) or country (`COUNTRY`) mapping.", "enum": [ "AS", "COUNTRY" ], "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/datacenter-diagnostics.yaml" } } } }, "description": "Successful response." } }, "summary": "Report datacenter diagnostics", "tags": [ "Diagnostics" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/diagnostics-datacenter.yaml", "path-info": "/diagnostics/datacenter/domains/{domain}" } }, "/diagnostics/ip/domains/{domain}/properties/{property}": { "get": { "description": "Returns diagnostic data showing the per-name server mapping decisions made by GTM for the given domain, property, IP address, and time period. Includes scoring details such as latency, ping scores, and which datacenter was selected.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-ip" }, "operationId": "get-diagnostics-ip", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "The IP address to filter diagnostic results by.", "in": "query", "name": "ip", "required": true, "schema": { "example": "192.0.2.1", "type": "string" }, "x-akamai": { "file-path": "parameters/ip-required-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "alive": true, "corePoint": "192.0.2.177", "corePointAutonomousSystem": 7922, "corePointCountry": "US", "datacenterId": 3200, "distanceFromCorePointToNameserver": 200, "distanceToDatacenter": 150, "latency": "0|50|100|200", "loss": "0|5|10", "mapType": "PING", "nameserver": { "autonomousSystem": 12345, "autonomousSystemName": "Example ISP", "country": "US", "ip": "192.0.2.1", "nsdAbsoluteRank": 5, "nsdCount": 1000, "nsdPercentOfAverage": 120.5 }, "pingScore": "85", "propertyType": "PERFORMANCE", "score": 85, "timestamp": "2021-05-23T00:05:00Z", "trafficMappedToDatacenter": true, "trafficTargetName": "US East Server" } ], "dataSummary": {}, "links": [ { "href": "/gtm-api/v1/reports/diagnostics/ip/domains/example.akadns.net/properties/www", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-05-24T00:00:00Z", "ip": "192.0.2.1", "property": "www", "start": "2021-05-23T00:00:00Z", "uri": "/gtm-api/v1/reports/diagnostics/ip/domains/example.akadns.net/properties/www" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "Per-name server diagnostic rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "alive": { "description": "Whether GTM considered the property server alive.", "nullable": true, "type": "boolean" }, "corePoint": { "description": "The core point IP used for performance calculations.", "nullable": true, "type": "string" }, "corePointAutonomousSystem": { "description": "The autonomous system number of the core point.", "nullable": true, "type": "integer" }, "corePointCountry": { "description": "The country code of the core point.", "nullable": true, "type": "string" }, "datacenterId": { "description": "The ID of the datacenter that was selected for this name server.", "type": "integer" }, "distanceFromCorePointToNameserver": { "description": "The distance in kilometers from the core point to the name server.", "nullable": true, "type": "integer" }, "distanceToDatacenter": { "description": "The distance in kilometers from the name server to the selected datacenter.", "nullable": true, "type": "integer" }, "latency": { "description": "The latency bucket for the name server-to-datacenter path.", "nullable": true, "type": "string" }, "loss": { "description": "The packet loss bucket for the name server-to-datacenter path.", "nullable": true, "type": "string" }, "mapType": { "description": "The mapping mechanism used to select the data center, either `FALLBACK`, `PING`, or `LOADBALANCER`.", "enum": [ "FALLBACK", "PING", "LOADBALANCER" ], "type": "string" }, "nameserver": { "additionalProperties": false, "description": "Information about the name server that issued the DNS query.", "properties": { "autonomousSystem": { "description": "The autonomous system number of the name server.", "type": "integer" }, "autonomousSystemName": { "description": "The name of the autonomous system.", "nullable": true, "type": "string" }, "country": { "description": "The country code of the name server.", "nullable": true, "type": "string" }, "ip": { "description": "The name server IP address.", "minLength": 1, "type": "string" }, "nsdAbsoluteRank": { "description": "The absolute rank of the name server by demand.", "nullable": true, "type": "integer" }, "nsdCount": { "description": "The name server demand count.", "nullable": true, "type": "integer" }, "nsdPercentOfAverage": { "description": "The name server demand as a percentage of the average.", "nullable": true, "type": "number" } }, "type": "object" }, "pingScore": { "description": "The ping score used in the mapping decision.", "nullable": true, "type": "string" }, "propertyType": { "description": "The type of GTM property, either `FAILOVER`, `QTR`, `ASMAPPING`, `CIDRMAPPING`, `GEOGRAPHIC`, `WEIGHTED_ROUND_ROBIN`, `WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK`, `WEIGHTED_HASHED`, `PERFORMANCE`, `PERFORMANCE_WITH_LOAD_FEEDBACK`, `PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS`, or `PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE`.", "enum": [ "FAILOVER", "QTR", "ASMAPPING", "CIDRMAPPING", "GEOGRAPHIC", "WEIGHTED_ROUND_ROBIN", "WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK", "WEIGHTED_HASHED", "PERFORMANCE", "PERFORMANCE_WITH_LOAD_FEEDBACK", "PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS", "PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE" ], "type": "string" }, "score": { "description": "The final score used in the mapping decision.", "type": "integer" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" }, "trafficMappedToDatacenter": { "description": "Whether the traffic from this name server was mapped to the datacenter.", "type": "boolean" }, "trafficTargetName": { "description": "The name of the traffic target selected.", "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "ip": { "description": "The IP address filtered on.", "minLength": 1, "type": "string" }, "property": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "property", "ip", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/ip-diagnostics.yaml" } } } }, "description": "Successful response." } }, "summary": "Report IP diagnostics", "tags": [ "Diagnostics" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/diagnostics-ip.yaml", "path-info": "/diagnostics/ip/domains/{domain}/properties/{property}" } }, "/diagnostics/mapdiff/domains/{domain}": { "get": { "description": "Returns a diff of traffic distribution map snapshots for the given domain and time period, showing how AS and country-to-datacenter mappings changed between consecutive five-minute intervals.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff" }, "operationId": "get-diagnostics-mapdiff", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "autonomousSystem": { "name": "Example ISP", "number": 12345 }, "country": null, "datacenter": { "datacenterId": 3200, "name": "US East" }, "direction": "INGRESS", "lhsTimestamp": "2021-05-23T00:00:00Z", "percent": 5.2, "rhsTimestamp": "2021-05-23T00:05:00Z", "type": "PER_DC_PER_AS_INGRESS" } ], "dataSummary": {}, "links": [ { "href": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-05-24T00:00:00Z", "start": "2021-05-23T00:00:00Z", "uri": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The map diff rows comparing two map snapshots.", "items": { "additionalProperties": false, "properties": { "autonomousSystem": { "additionalProperties": false, "description": "The autonomous system associated with this diff row.", "nullable": true, "properties": { "name": { "description": "The autonomous system name.", "minLength": 1, "type": "string" }, "number": { "description": "The autonomous system number.", "type": "integer" } }, "type": "object" }, "country": { "additionalProperties": false, "description": "The country associated with this diff row.", "nullable": true, "properties": { "code": { "description": "The two-letter ISO country code.", "minLength": 1, "type": "string" }, "continentCode": { "description": "The two-letter continent code, either `AF` (Africa), `AN` (Antarctica), `AS` (Asia), `EU` (Europe), `NA` (North America), `OC` (Oceania), or `SA` (South America). `null` if unknown.", "enum": [ "AF", "AN", "AS", "EU", "NA", "OC", "SA" ], "nullable": true, "type": "string" }, "name": { "description": "The full country name.", "minLength": 1, "type": "string" } }, "type": "object" }, "datacenter": { "additionalProperties": false, "description": "The datacenter associated with this diff row.", "nullable": true, "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "name": { "description": "The datacenter nickname.", "minLength": 1, "type": "string" } }, "type": "object" }, "direction": { "description": "The traffic direction represented by this row, either `BIDIRECTIONAL`, `INGRESS`, or `EGRESS`.", "enum": [ "BIDIRECTIONAL", "INGRESS", "EGRESS" ], "type": "string" }, "lhsTimestamp": { "description": "An ISO 8601 timestamp of the earlier (left-hand side) map snapshot.", "type": "string" }, "percent": { "description": "The percentage change between the two map snapshots.", "type": "number" }, "rhsTimestamp": { "description": "An ISO 8601 timestamp of the later (right-hand side) map snapshot.", "type": "string" }, "type": { "description": "The category of this diff row, either `OVERALL_AS`, `OVERALL_COUNTRY`, `PER_DC_INGRESS`, `PER_DC_EGRESS`, `PER_DC_PER_AS_INGRESS`, `PER_DC_PER_AS_EGRESS`, `PER_DC_PER_COUNTRY_INGRESS`, `PER_DC_PER_COUNTRY_EGRESS`, `GEO`, or `PING`.", "enum": [ "OVERALL_AS", "OVERALL_COUNTRY", "PER_DC_INGRESS", "PER_DC_EGRESS", "PER_DC_PER_AS_INGRESS", "PER_DC_PER_AS_EGRESS", "PER_DC_PER_COUNTRY_INGRESS", "PER_DC_PER_COUNTRY_EGRESS", "GEO", "PING" ], "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/mapdiff-diagnostics.yaml" } } } }, "description": "Successful response." } }, "summary": "Report map diff diagnostics", "tags": [ "Diagnostics" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/diagnostics-mapdiff.yaml", "path-info": "/diagnostics/mapdiff/domains/{domain}" } }, "/diagnostics/mapdiff/domains/{domain}/datacenters/{datacenterId}/as/{asNumber}": { "get": { "description": "Returns detailed geo and ping score time series for the given domain, datacenter, and autonomous system over the specified time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff-datacenter-as" }, "operationId": "get-diagnostics-mapdiff-datacenter-as", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "geoScore": 72.4, "pingScore": 85.1, "timestamp": "2021-05-23T00:05:00Z" } ], "dataSummary": {}, "links": [ { "href": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net/datacenters/3200/as/12345", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-05-24T00:00:00Z", "start": "2021-05-23T00:00:00Z", "uri": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net/datacenters/3200/as/12345" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The detailed score rows for the datacenter and AS or country combination.", "items": { "additionalProperties": false, "properties": { "geoScore": { "description": "The geographic score at this timestamp.", "nullable": true, "type": "number" }, "pingScore": { "description": "The ping score at this timestamp.", "nullable": true, "type": "number" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data point was recorded.", "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/mapdiff-detailed-diagnostics.yaml" } } } }, "description": "Successful response." } }, "summary": "Report detailed map diff diagnostics for a data center and AS", "tags": [ "Diagnostics" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } }, { "description": "Data center ID.", "in": "path", "name": "datacenterId", "required": true, "schema": { "example": 3200, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-path.yaml" } }, { "description": "The autonomous system number.", "in": "path", "name": "asNumber", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/as-number-path.yaml" } } ], "x-akamai": { "file-path": "paths/diagnostics-mapdiff-datacenter-as.yaml", "path-info": "/diagnostics/mapdiff/domains/{domain}/datacenters/{datacenterId}/as/{asNumber}" } }, "/diagnostics/mapdiff/domains/{domain}/datacenters/{datacenterId}/countries/{countryCode}": { "get": { "description": "Returns detailed geo and ping score time series for the given domain, datacenter, and country over the specified time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff-datacenter-country" }, "operationId": "get-diagnostics-mapdiff-datacenter-country", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "geoScore": 72.4, "pingScore": 85.1, "timestamp": "2021-05-23T00:05:00Z" } ], "dataSummary": {}, "links": [ { "href": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net/datacenters/3200/as/12345", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-05-24T00:00:00Z", "start": "2021-05-23T00:00:00Z", "uri": "/gtm-api/v1/reports/diagnostics/mapdiff/domains/example.akadns.net/datacenters/3200/as/12345" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The detailed score rows for the datacenter and AS or country combination.", "items": { "additionalProperties": false, "properties": { "geoScore": { "description": "The geographic score at this timestamp.", "nullable": true, "type": "number" }, "pingScore": { "description": "The ping score at this timestamp.", "nullable": true, "type": "number" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data point was recorded.", "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/mapdiff-detailed-diagnostics.yaml" } } } }, "description": "Successful response." } }, "summary": "Report detailed map diff diagnostics for a data center and country", "tags": [ "Diagnostics" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } }, { "description": "Data center ID.", "in": "path", "name": "datacenterId", "required": true, "schema": { "example": 3200, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-path.yaml" } }, { "description": "The two-letter ISO country code.", "in": "path", "name": "countryCode", "required": true, "schema": { "example": "US", "type": "string" }, "x-akamai": { "file-path": "parameters/country-code-path.yaml" } } ], "x-akamai": { "file-path": "paths/diagnostics-mapdiff-datacenter-country.yaml", "path-info": "/diagnostics/mapdiff/domains/{domain}/datacenters/{datacenterId}/countries/{countryCode}" } }, "/domain-list": { "get": { "description": "This 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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-domain-list" }, "operationId": "get-domain-list", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "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" } ] }, "schema": { "additionalProperties": false, "properties": { "domains": { "description": "The GTM domain names accessible to the current user.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" } }, "required": [ "domains", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-list.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a domain list", "tags": [ "Domains" ] }, "x-akamai": { "file-path": "paths/domains.yaml", "path-info": "/domain-list" } }, "/domain-list/accounts/{accountId}/contract-types/{contractTypeId}/domain-names": { "get": { "description": "Returns a list of GTM domain names accessible to the current user for the given account and contract type.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-domain-names-for-account" }, "operationId": "get-domain-names-for-account", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ "example.akadns.net", "example2.akadns.net" ], "schema": { "description": "GTM domain names accessible to the current user.", "items": { "minLength": 1, "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/domain-names.yaml" } } } }, "description": "Successful response." } }, "summary": "List domain names for an account and contract type", "tags": [ "Domains" ] }, "parameters": [ { "description": "The unique identifier for an Akamai account.", "in": "path", "name": "accountId", "required": true, "schema": { "example": "A-CCT3456", "type": "string" }, "x-akamai": { "file-path": "parameters/account-id-path.yaml" } }, { "description": "The unique identifier for a contract type.", "in": "path", "name": "contractTypeId", "required": true, "schema": { "example": "1-8BYUX", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-type-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-names-for-account.yaml", "path-info": "/domain-list/accounts/{accountId}/contract-types/{contractTypeId}/domain-names" } }, "/domain-list/domain-names": { "get": { "description": "Returns a list of GTM domain names accessible to the current user.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-domain-names" }, "operationId": "get-domain-names", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ "example.akadns.net", "example2.akadns.net" ], "schema": { "description": "GTM domain names accessible to the current user.", "items": { "minLength": 1, "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/domain-names.yaml" } } } }, "description": "Successful response." } }, "summary": "List domain names", "tags": [ "Domains" ] }, "x-akamai": { "file-path": "paths/domain-names.yaml", "path-info": "/domain-list/domain-names" } }, "/domain-list/{domain}": { "get": { "description": "This operation retrieves a list of property names, as well as Datacenter names and IDs for a given domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-domain-list-domain" }, "operationId": "get-domain-list-domain", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "datacenters": [ { "datacenterId": 3132, "datacenterNickname": "Winterfell" }, { "datacenterId": 3133, "datacenterNickname": "Braavos" } ], "links": [ { "href": "/gtm-api/v1/reports/domain-list/example.akadns.net", "rel": "self" } ], "name": "example.akadns.net", "properties": [ "www", "db" ], "resources": [ "cpu", "disk" ] }, "schema": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers configured for the domain.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "datacenterNickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "datacenterNickname" ], "type": "object" }, "type": "array" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "name": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "properties": { "description": "The GTM property names configured for the domain.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "resources": { "description": "The load-feedback resource names configured for the domain.", "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "name", "properties", "datacenters", "resources", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-summary.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a domain summary", "tags": [ "Domains" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain.yaml", "path-info": "/domain-list/{domain}" } }, "/ip-availability/domains/{domain}/properties/{property}": { "get": { "description": "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, `handedOut` in JSON or `handOut` in CSV indicates whether the server was handed out and alive indicates whether GTM considered the server as alive or not.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-ip-availability-property" }, "operationId": "get-ip-availability-property", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "IP address of the server.", "in": "query", "name": "ip", "schema": { "example": "192.0.2.153", "type": "string" }, "x-akamai": { "file-path": "parameters/ip-query.yaml" } }, { "description": "Most recent update.", "in": "query", "name": "mostRecent", "schema": { "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/most-recent-query.yaml" } }, { "description": "Data center ID.", "in": "query", "name": "datacenterId", "schema": { "example": 3132, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "cutOff": 112.5, "datacenters": [ { "IPs": [ { "alive": true, "handedOut": true, "ip": "192.0.2.83", "score": 75 } ], "datacenterId": 3132, "nickname": "Winterfell", "trafficTargetName": "Winterfell - 1.2.3.4" }, { "IPs": [ { "alive": true, "handedOut": true, "ip": "192.0.2.5", "score": 85 } ], "datacenterId": 3133, "nickname": "Braavos", "trafficTargetName": "Braavos - 1.2.3.5" } ], "timestamp": "2021-02-23T21:42:35Z" }, { "cutOff": 112.5, "datacenters": [ { "IPs": [ { "alive": false, "handedOut": false, "ip": "192.0.2.227", "score": 115 } ], "datacenterId": 3132, "nickname": "Winterfell", "trafficTargetName": "Winterfell - 1.2.3.4" }, { "IPs": [ { "alive": true, "handedOut": true, "ip": "192.0.2.235", "score": 75 } ], "datacenterId": 3133, "nickname": "Braavos", "trafficTargetName": "Braavos - 1.2.3.5" } ], "timestamp": "2021-03-23T21:42:35Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/ip-availability/domains/example.akadns.net/properties/www", "rel": "self" } ], "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" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The IP availability data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "cutOff": { "description": "The cutoff score threshold. Servers with a score above this value are considered down.", "type": "number" }, "datacenters": { "description": "The data centers included in this IP availability row.", "items": { "additionalProperties": false, "properties": { "IPs": { "description": "The IP addresses for this traffic target and their availability scores.", "items": { "additionalProperties": false, "properties": { "alive": { "description": "Whether GTM considered this IP address alive.", "type": "boolean" }, "handedOut": { "description": "Whether this IP address was handed out to resolvers.", "type": "boolean" }, "ip": { "description": "The IP address of the server.", "minLength": 1, "type": "string" }, "score": { "description": "The server availability score.", "type": "number" } }, "required": [ "ip", "handedOut", "score", "alive" ], "type": "object" }, "type": "array" }, "datacenterId": { "description": "The data center ID.", "type": "integer" }, "nickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "trafficTargetName": { "description": "The name of the traffic target.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname", "trafficTargetName", "IPs" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "required": [ "timestamp", "cutOff", "datacenters" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "datacenterId": { "description": "The ID of the data center filtered on, if applicable.", "type": "integer" }, "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "ip": { "description": "The IP address filtered on, if applicable.", "minLength": 1, "type": "string" }, "mostRecent": { "description": "Whether only the most recent data point was returned.", "type": "boolean" }, "property": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "property", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows" ], "type": "object", "x-akamai": { "file-path": "schemas/ip-status.yaml" } } }, "text/csv": { "example": "\"timestamp\",\"domain\",\"property\",\"datacenterId\",\"datacenterNickname\",\"ip\",\"score\",\"cutOff\",\"handOut\",\"alive\"\n\"2021-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\"\n\"2021-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\"\n\"2021-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\"\n\"2021-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\"", "schema": { "type": "string" } } }, "description": "Successful response." } }, "summary": "List IP availability per property", "tags": [ "IP availability" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/property-ip-availability.yaml", "path-info": "/ip-availability/domains/{domain}/properties/{property}" } }, "/latency/domains/{domain}/datacenters/{datacenterId}": { "get": { "description": "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: `|`).\n\nPing 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. That is, in the above example if loss schema were `0|5|80|` then it would mean `0%`, `0%` to `5%`, and `5%` to `80%`.\n\nLatency 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`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-latency-datacenter" }, "operationId": "get-latency-datacenter", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "Latency Bucket Schema.", "in": "query", "name": "latency", "schema": { "default": "20|50|100|200|500", "example": "0|100|200|1000", "type": "string" }, "x-akamai": { "file-path": "parameters/latency-query.yaml" } }, { "description": "Loss Bucket Schema.", "in": "query", "name": "loss", "schema": { "default": "0|20|40|60|80|100", "example": "0|10|20|100", "type": "string" }, "x-akamai": { "file-path": "parameters/loss-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T17:11:26Z" }, { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T17:21:30Z" }, { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T17:31:31Z" }, { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T17:41:27Z" }, { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T17:51:30Z" }, { "latency": [ 0, 100, 0 ], "loss": [ 100, 0, 0 ], "timestamp": "2021-02-14T18:01:27Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/latency/domains/example.akadns.net/datacenters/14762?start=2021-02-14T17:11:26Z&end=2021-02-14T18:11:26Z&latency=0%7C1000&loss=0%7C100", "rel": "self" } ], "metadata": { "datacenterId": 3200, "datacenterNickname": "Winterfell", "domain": "example.akadns.net", "end": "2021-02-14T18:11:26Z", "latency": "0|1000", "loss": "0|100", "start": "2021-02-14T17:11:26Z", "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/latency/domains/example.akadns.net/datacenters/14762?start=2021-02-14T17:11:26Z&end=2021-02-14T18:11:26Z&latency=0%7C1000&loss=0%7C100" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The latency data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "latency": { "description": "The latency bucket counts for each defined range.", "items": { "type": "integer" }, "type": "array" }, "loss": { "description": "The packet loss bucket counts for each defined range.", "items": { "type": "integer" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "required": [ "timestamp", "latency", "loss" ], "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "datacenterNickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "latency": { "description": "The latency bucket schema applied to this report.", "minLength": 1, "type": "string" }, "loss": { "description": "The packet loss bucket schema applied to this report.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "datacenterId", "datacenterNickname", "latency", "loss", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/latency.yaml" } } }, "text/csv": { "example": "\"domain\",\"datacenterId\",\"datacenterNickname\",\"timestamp\",\"latency\",\"loss\"\n\"example.akadns.net\",\"3200\",\"Winterfell\",\"2021-02-25T14:24:07Z\",\"[0, 100, 0]\",\"[97, 3, 0]\"\n\"example.akadns.net\",\"3200\",\"Winterfell\",\"2021-02-25T14:34:10Z\",\"[0, 100, 0]\",\"[97, 3, 0]\"" } }, "description": "Successful response." } }, "summary": "Report latency per data center", "tags": [ "Latency" ] }, "parameters": [ { "description": "Data center ID.", "in": "path", "name": "datacenterId", "required": true, "schema": { "example": 3200, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/datacenter-latency.yaml", "path-info": "/latency/domains/{domain}/datacenters/{datacenterId}" } }, "/liveness-tests/domains/{domain}/properties/{property}": { "get": { "description": "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.\n\nLiveness 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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-property" }, "operationId": "get-liveness-tests-property", "parameters": [ { "description": "Date of report, in ISO 8601 format of `YYYY-MM-DD`.", "in": "query", "name": "date", "required": true, "schema": { "example": "2021-08-31", "type": "string" }, "x-akamai": { "file-path": "parameters/date-query.yaml" } }, { "description": "Filter results by Agent IP.", "in": "query", "name": "agentIp", "schema": { "example": "192.0.2.213", "type": "string" }, "x-akamai": { "file-path": "parameters/agent-ip-query.yaml" } }, { "description": "Filter results by Target IP.", "in": "query", "name": "targetIp", "schema": { "example": "192.0.2.2", "type": "string" }, "x-akamai": { "file-path": "parameters/target-ip-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "datacenters": [ { "agentIp": "192.0.2.234", "datacenterId": 3201, "duration": 0, "errorCode": 3101, "nickname": "Winterfell", "targetIp": "192.0.2.223", "testName": "Our defences", "trafficTargetName": "Winterfell - 1.2.3.4" } ], "timestamp": "2021-11-23T00:13:23Z" }, { "datacenters": [ { "agentIp": "192.0.2.75", "datacenterId": 3202, "duration": 0, "errorCode": 3101, "nickname": "Braavos", "targetIp": "192.0.2.53", "testName": "Our defences", "trafficTargetName": "Braavos - 1.2.3.5" } ], "timestamp": "2021-11-23T00:15:13Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/liveness-tests/domains/example.akadns.net/properties/www?date=2021-11-23", "rel": "self" } ], "metadata": { "date": "2021-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=2021-11-23" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The liveness test failure rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers with liveness test failures for this timestamp.", "items": { "additionalProperties": false, "properties": { "agentIp": { "description": "The IP address of the web agent that ran the liveness test.", "minLength": 1, "type": "string" }, "datacenterId": { "description": "The data center ID.", "type": "integer" }, "duration": { "description": "The duration of the consecutive failure run, in seconds.", "type": "integer" }, "errorCode": { "description": "The liveness test error code.", "type": "integer" }, "nickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "targetIp": { "description": "The IP address of the origin server tested.", "minLength": 1, "type": "string" }, "testName": { "description": "The name of the liveness test.", "minLength": 1, "type": "string" }, "trafficTargetName": { "description": "The name of the traffic target.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname", "trafficTargetName", "targetIp", "agentIp", "testName", "errorCode", "duration" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "required": [ "timestamp", "datacenters" ], "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "agentIp": { "description": "The IP address of the web agent filtered on, if applicable.", "format": "ip", "type": "string" }, "date": { "description": "The date of the liveness test report.", "format": "date", "type": "string" }, "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "property": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "targetIp": { "description": "The IP address of the origin server filtered on, if applicable.", "format": "ip", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "property", "date", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-tests.yaml" } } }, "text/csv": { "example": "\"domain\",\"property\",\"timestamp\",\"datacenterId\",\"datacenterNickname\",\"trafficTargetName\",\"targetIp\",\"agentIp\",\"testName\",\"duration\",\"errorCode\"\n\"example.akadns.net\",\"www\",\"2021-12-04T01:57:21Z\",\"3200\",\"Winterfell\",\"Winterfell - 1.2.3.4\",\"1.2.3.4\",\"80.67.75.14\",\"Our defences\",\"3110\"\n\"example.akadns.net\",\"www\",\"2021-12-04T01:57:53Z\",\"3201\",\"Braavos\",\"1.2.3.5\",\"80.67.75.14\",\"Our defences\",\"3100\"\n\"example.akadns.net\",\"www\",\"2021-12-04T01:59:05Z\",\"3200\",\"Winterfell\",\"Winterfell - 1.2.3.4\",\"1.2.3.4\",\"69.31.121.20\",\"Our defences\",\"3101\"\n\"example.akadns.net\",\"www\",\"2021-12-04T01:59:46Z\",\"3201\",\"Braavos\",\"Braavos - 1.2.3.5\",\"1.2.3.5\",\"65.124.174.194\",\"Our defences\",\"3101\"" } }, "description": "Successful response." } }, "summary": "Report liveness per property", "tags": [ "Liveness" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/property-liveness-tests.yaml", "path-info": "/liveness-tests/domains/{domain}/properties/{property}" } }, "/liveness-tests/error-code-descriptions": { "get": { "description": "This operation lists all the possible liveness test error codes (as displayed on the Liveness Test Failures report) and a description of each error.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-error-codes" }, "operationId": "get-liveness-tests-error-codes", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "errorCode": 3082, "errorDescription": "Attempting to link in too many shared libraries" }, { "errorCode": 3081, "errorDescription": ".lib section in a.out corrupted" } ] }, "schema": { "additionalProperties": false, "properties": { "items": { "description": "The liveness test error codes and their descriptions.", "items": { "additionalProperties": false, "properties": { "errorCode": { "description": "The numeric liveness test error code.", "type": "integer" }, "errorDescription": { "description": "A human-readable description of the error code.", "minLength": 1, "type": "string" } }, "required": [ "errorCode", "errorDescription" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-error-codes.yaml" } } }, "text/csv": { "example": "\"errorCode \",\"errorDescription\"\n\"3082\",\"Attempting to link in too many shared libraries\"\n\"3081\",\".lib section in a.out corrupted\"" } }, "description": "Successful response." } }, "summary": "List liveness test errors", "tags": [ "Liveness" ] }, "x-akamai": { "file-path": "paths/error-code-descriptions.yaml", "path-info": "/liveness-tests/error-code-descriptions" } }, "/liveness-tests/error-code-descriptions/{errorCode}": { "get": { "description": "This operation returns an error description for the given Liveness Test error ID.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-error-code" }, "operationId": "get-liveness-tests-error-code", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "errorCode": 3082, "errorDescription": "Attempting to link in too many shared libraries" } ] }, "schema": { "additionalProperties": false, "properties": { "items": { "description": "The liveness test error codes and their descriptions.", "items": { "additionalProperties": false, "properties": { "errorCode": { "description": "The numeric liveness test error code.", "type": "integer" }, "errorDescription": { "description": "A human-readable description of the error code.", "minLength": 1, "type": "string" } }, "required": [ "errorCode", "errorDescription" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-error-codes.yaml" } } }, "text/csv": { "example": "\"errorCode \",\"errorDescription\"\n\"3082\",\"Attempting to link in too many shared libraries\"" } }, "description": "Successful response." } }, "summary": "Get a Liveness Test error", "tags": [ "Liveness" ] }, "parameters": [ { "description": "Error identification number.", "in": "path", "name": "errorCode", "required": true, "schema": { "example": 3082, "type": "number" }, "x-akamai": { "file-path": "parameters/error-code-path.yaml" } } ], "x-akamai": { "file-path": "paths/error-code.yaml", "path-info": "/liveness-tests/error-code-descriptions/{errorCode}" } }, "/liveness-tests/window": { "get": { "description": "Returns 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 report endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-window" }, "operationId": "get-liveness-tests-window", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "end": "2021-02-23T15:05:00Z", "start": "2021-02-13T00:00:00Z" }, "schema": { "additionalProperties": false, "description": "The time range of data available for a report.", "properties": { "end": { "description": "An ISO 8601 timestamp indicating when the available data ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the available data begins.", "type": "string" } }, "required": [ "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/report-window.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a liveness test report window", "tags": [ "Liveness" ] }, "x-akamai": { "file-path": "paths/liveness-tests-window.yaml", "path-info": "/liveness-tests/window" } }, "/load-feedback/domains/{domain}/most-recent-load-data": { "get": { "description": "Returns 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 data centers.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-most-recent-load-data" }, "operationId": "get-most-recent-load-data", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "capacity": 100, "capacitySmoothed": 100, "current": 42, "currentSmoothed": 40, "datacenterId": 3200, "datacenterName": "US East", "errortype": "", "ip": "192.0.2.10", "loadserver": "loadserver.example.akadns.net", "resource": "cpu", "tag": "abc123", "target": 80, "targetSmoothed": 78, "time": "2021-05-23T12:00:00Z" } ] }, "schema": { "additionalProperties": false, "properties": { "data": { "description": "The most recent load feedback data points across all data centers for the domain.", "items": { "additionalProperties": false, "properties": { "capacity": { "description": "The capacity raw value.", "type": "integer" }, "capacitySmoothed": { "description": "The capacity smoothed value.", "type": "integer" }, "current": { "description": "The current raw load value.", "type": "integer" }, "currentSmoothed": { "description": "The current smoothed load value.", "type": "integer" }, "datacenterId": { "description": "The ID of the data center reporting this load value.", "type": "integer" }, "datacenterName": { "description": "The nickname of the data center.", "minLength": 1, "type": "string" }, "errortype": { "description": "The error type if load feedback reporting failed, or empty if successful.", "type": "string" }, "ip": { "description": "The IP address of the load reporting server.", "minLength": 1, "type": "string" }, "loadserver": { "description": "The hostname of the load reporting server.", "minLength": 1, "type": "string" }, "resource": { "description": "The name of the resource being measured.", "minLength": 1, "type": "string" }, "tag": { "description": "An opaque tag identifying the load feedback session.", "type": "string" }, "target": { "description": "The target raw load value.", "type": "integer" }, "targetSmoothed": { "description": "The target smoothed load value.", "type": "integer" }, "time": { "description": "An ISO 8601 timestamp indicating when this load feedback reading was taken.", "type": "string" } }, "required": [ "current", "currentSmoothed", "datacenterId", "datacenterName", "resource", "target", "targetSmoothed", "capacity", "capacitySmoothed", "ip", "errortype", "tag", "time", "loadserver" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object", "x-akamai": { "file-path": "schemas/most-recent-load-feedback.yaml" } } } }, "description": "Successful response." } }, "summary": "Get most recent load feedback data", "tags": [ "Load feedback" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/most-recent-load-data.yaml", "path-info": "/load-feedback/domains/{domain}/most-recent-load-data" } }, "/load-feedback/domains/{domain}/resources/{resource}": { "get": { "description": "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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-load-feedback" }, "operationId": "get-load-feedback", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "datacenters": [ { "currentLoad": 20, "datacenterId": 3135, "maximumLoad": 40, "nickname": "Winterfell", "targetLoad": 30 }, { "currentLoad": 30, "datacenterId": 3139, "maximumLoad": 40, "nickname": "Bravoos", "targetLoad": 40 }, { "currentLoad": 10, "datacenterId": 3140, "maximumLoad": 15, "nickname": "King's Landing", "targetLoad": 10 } ], "timestamp": "2021-02-14T01:32:52Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/load-feedback/domains/example.akadns.net/resources/cpu?start=2021-02-14T01:32:52Z&end=2021-02-14T01:40:52Z", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-02-14T01:40:52Z", "resource": "cpu", "start": "2021-02-14T01:32:52Z", "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/load-feedback/domains/example.akadns.net/resources/cpu?start=2021-02-14T01:32:52Z&end=2021-02-14T01:40:52Z" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The load feedback data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers included in this load feedback row.", "items": { "additionalProperties": false, "properties": { "currentLoad": { "description": "The current load reported by this data center.", "type": "number" }, "datacenterId": { "description": "The data center ID.", "type": "integer" }, "maximumLoad": { "description": "The maximum load capacity of this data center.", "type": "number" }, "nickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "targetLoad": { "description": "The target load for this data center.", "type": "number" } }, "required": [ "datacenterId", "nickname", "currentLoad", "targetLoad", "maximumLoad" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "resource": { "description": "The load-feedback resource name.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "domain", "resource", "start", "end", "uri" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/load-feedback.yaml" } } }, "text/csv": { "example": "\"domain\",\"resource\",\"timestamp\",\"datacenterId\",\"datacenterNickname\",\"currentLoad\",\"targetLoad\",\"maximumLoad\"\n\"example.akadns.net\",\"cpu\",\"2021-02-25T03:46:51Z\",\"3200\",\"Winterfell\",\"20\",\"30\",\"40\"\n\"example.akadns.net\",\"cpu\",\"2021-02-25T03:46:51Z\",\"3201\",\"Braavos\",\"30\",\"40\",\"40\"\n\"example.akadns.net\",\"cpu\",\"2021-02-25T04:46:51Z\",\"3200\",\"Winterfell\",\"10\",\"30\",\"40\"\n\"example.akadns.net\",\"cpu\",\"2021-02-25T04:46:51Z\",\"3201\",\"Braavos\",\"10\",\"40\",\"40\"" } }, "description": "Successful response." } }, "summary": "Report load feedback", "tags": [ "Load feedback" ] }, "parameters": [ { "description": "Name of the resource.", "in": "path", "name": "resource", "required": true, "schema": { "example": "cpu", "type": "string" }, "x-akamai": { "file-path": "parameters/resource-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/resource.yaml", "path-info": "/load-feedback/domains/{domain}/resources/{resource}" } }, "/load-feedback/domains/{domain}/window": { "get": { "description": "Returns 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 report endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-load-feedback-window" }, "operationId": "get-load-feedback-window", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "end": "2021-02-23T15:05:00Z", "start": "2021-02-13T00:00:00Z" }, "schema": { "additionalProperties": false, "description": "The time range of data available for a report.", "properties": { "end": { "description": "An ISO 8601 timestamp indicating when the available data ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the available data begins.", "type": "string" } }, "required": [ "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/report-window.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a load feedback report window", "tags": [ "Load feedback" ] }, "parameters": [ { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/load-feedback-window.yaml", "path-info": "/load-feedback/domains/{domain}/window" } }, "/traffic/datacenters-window": { "get": { "description": "Returns 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 traffic report endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-datacenters-window" }, "operationId": "get-traffic-datacenters-window", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "end": "2021-02-23T15:05:00Z", "start": "2021-02-13T00:00:00Z" }, "schema": { "additionalProperties": false, "description": "The time range of data available for a report.", "properties": { "end": { "description": "An ISO 8601 timestamp indicating when the available data ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the available data begins.", "type": "string" } }, "required": [ "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/report-window.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a datacenter traffic report window", "tags": [ "Traffic" ] }, "x-akamai": { "file-path": "paths/traffic-datacenters-window.yaml", "path-info": "/traffic/datacenters-window" } }, "/traffic/domains/{domain}/datacenters/{datacenterId}": { "get": { "description": "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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-datacenter" }, "operationId": "get-traffic-datacenter", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "properties": [ { "name": "www", "requests": 45, "status": "1" } ], "timestamp": "2021-11-23T00:00:00Z" }, { "properties": [ { "name": "www", "requests": 45, "status": "1" } ], "timestamp": "2021-11-23T00:05:00Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters?start=2021-11-23T00:00:00Z&2021-11-23T00:10:00Z", "rel": "self" } ], "metadata": { "datacenterId": 3200, "datacenterNickname": "Winterfell", "domain": "example.akadns.net", "end": "2021-11-23T00:10:00Z", "interval": "FIVE_MINUTE", "start": "2021-11-23T00:00:00Z", "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/datacenters?start=2021-11-23T00:00:00Z&end=2021-11-23T00:10:00Z" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The traffic data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "properties": { "description": "The properties that received traffic from this data center during this interval.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "requests": { "description": "The number of DNS requests received during this interval.", "type": "number" }, "status": { "description": "The status code for this property during this interval.", "minLength": 1, "type": "string" } }, "required": [ "name", "requests", "status" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "required": [ "timestamp", "properties" ], "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URL.", "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "datacenterNickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "interval": { "description": "The reporting interval. Always `FIVE_MINUTE`.", "enum": [ "FIVE_MINUTE" ], "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "uri", "domain", "datacenterId", "datacenterNickname", "start", "end" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/traffic-datacenter.yaml" } } }, "text/csv": { "example": "\"timestamp\",\"domain\",\"property\",\"datacenterId\",\"datacenterNickname\",\"requests\",\"status\"\n\"2021-03-01T20:30:00Z\",\"example.akadns.net\",\"www\",\"3132\",\"Winterfell\",\"39\",\"1\"\n\"2021-03-01T20:35:00Z\",\"example.akadns.net\",\"www\",\"3132\",\"Winterfell\",\"266\",\"1\"" } }, "description": "Successful response." } }, "summary": "Report traffic per data center", "tags": [ "Traffic" ] }, "parameters": [ { "description": "Data center ID.", "in": "path", "name": "datacenterId", "required": true, "schema": { "example": 3200, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/datacenter-traffic.yaml", "path-info": "/traffic/domains/{domain}/datacenters/{datacenterId}" } }, "/traffic/domains/{domain}/properties/{property}": { "get": { "description": "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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-property" }, "operationId": "get-traffic-property", "parameters": [ { "description": "Start date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-05-23T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "End date of report, in ISO 8601 format of `YYYY-MM-DDThh:mm:ssZ` in UTC time.", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-05-24T01:56:13Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "datacenters": [ { "datacenterId": 3130, "nickname": "Winterfell", "requests": 34, "status": "1", "trafficTargetName": "Winterfell - 1.2.3.4" } ], "timestamp": "2021-11-24T01:40:00Z" }, { "datacenters": [ { "datacenterId": 3130, "nickname": "Winterfell", "requests": 45, "status": "1", "trafficTargetName": "Winterfell - 1.2.3.4" } ], "timestamp": "2021-11-24T01:45:00Z" } ], "links": [ { "href": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/properties/www?start=2021-11-23T00:00:00Z&2021-11-24T01:50:00Z", "rel": "self" } ], "metadata": { "domain": "example.akadns.net", "end": "2021-11-24T01:50:00Z", "interval": "FIVE_MINUTE", "property": "www", "start": "2021-11-24T01:40:00Z", "uri": "https://akab-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/gtm-api/v1/reports/traffic/domains/example.akadns.net/properties/www?start=2021-11-23T00:00:00Z&2021-11-24T01:50:00Z" } }, "schema": { "additionalProperties": false, "properties": { "dataRows": { "description": "The traffic data rows for the reporting period.", "items": { "additionalProperties": false, "properties": { "datacenters": { "description": "The data centers that received traffic for this property during this interval.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "The data center ID.", "type": "integer" }, "nickname": { "description": "The data center nickname.", "minLength": 1, "type": "string" }, "requests": { "description": "The number of DNS requests received during this interval.", "type": "number" }, "status": { "description": "The status code for this data center during this interval.", "minLength": 1, "type": "string" }, "trafficTargetName": { "description": "The name of the traffic target.", "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname", "trafficTargetName", "requests", "status" ], "type": "object" }, "type": "array" }, "timestamp": { "description": "An ISO 8601 timestamp indicating when this data row was recorded.", "type": "string" } }, "required": [ "timestamp", "datacenters" ], "type": "object" }, "type": "array" }, "dataSummary": { "description": "Summary statistics for the report.", "type": "object" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `first`, `next`, and `last` link to different sets of paginated data.", "minLength": 1, "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Report metadata describing the query parameters and resource URI.", "properties": { "domain": { "description": "The GTM domain name.", "minLength": 1, "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating when the reporting period ends.", "type": "string" }, "interval": { "description": "The reporting interval. Always `FIVE_MINUTE`.", "enum": [ "FIVE_MINUTE" ], "type": "string" }, "property": { "description": "The GTM property name.", "minLength": 1, "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the reporting period starts.", "type": "string" }, "uri": { "description": "The URL of this report.", "format": "uri", "type": "string" } }, "required": [ "uri", "domain", "property", "start", "end" ], "type": "object" } }, "required": [ "metadata", "dataRows", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/traffic-property.yaml" } } }, "text/csv": { "example": "\"timestamp\",\"domain\",\"property\",\"datacenterId\",\"datacenterNickname\",\"trafficTargetName\",\"requests\",\"status\"\n\"2021-03-01T20:30:00Z\",\"example.akadns.net\",\"www\",\"3132\",\"Winterfell\",\"Winterfell - 1.2.3.4\",\"39\",\"1\"\n\"2021-03-01T20:35:00Z\",\"example.akadns.net\",\"www\",\"3133\",\"Braavos\",\"Braavos - 1.2.3.5\",\"266\",\"1\"" } }, "description": "Successful response." } }, "summary": "Report traffic per property", "tags": [ "Traffic" ] }, "parameters": [ { "description": "Name of Traffic Management property.", "in": "path", "name": "property", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Name of Traffic Management domain.", "in": "path", "name": "domain", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/property-traffic.yaml", "path-info": "/traffic/domains/{domain}/properties/{property}" } }, "/traffic/properties-window": { "get": { "description": "Returns 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 report endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management Reporting API", "url": "https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-properties-window" }, "operationId": "get-traffic-properties-window", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "end": "2021-02-23T15:05:00Z", "start": "2021-02-13T00:00:00Z" }, "schema": { "additionalProperties": false, "description": "The time range of data available for a report.", "properties": { "end": { "description": "An ISO 8601 timestamp indicating when the available data ends.", "type": "string" }, "start": { "description": "An ISO 8601 timestamp indicating when the available data begins.", "type": "string" } }, "required": [ "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/report-window.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a property traffic report window", "tags": [ "Traffic" ] }, "x-akamai": { "file-path": "paths/traffic-properties-window.yaml", "path-info": "/traffic/properties-window" } } }, "servers": [ { "url": "https://{hostname}/gtm-api/v1/reports" } ], "tags": [ { "description": "Lists domain names and details for their data centers.", "name": "Domains" }, { "description": "Provides details on DNS requests for GTM properties in a five minute period.", "name": "Traffic" }, { "description": "Provides details about GTM domain liveness tests.", "name": "Liveness" }, { "description": "Reports on demand percent versus actual demand percent seen by GTM rounded off to the nearest five minute interval for each data center.", "name": "Directed demand" }, { "description": "Reports on the historical values of a given resource across all data centers and the given time period.", "name": "Load feedback" }, { "description": "Reports on latency and loss of ping data by network agents in each data center for a GTM property.", "name": "Latency" }, { "description": "Returns scores from Web agents to calculate server scores to make GTM liveness decisions.", "name": "IP availability" }, { "description": "Provides diagnostic data on how GTM is distributing traffic, including datacenter mapping decisions, per-IP routing logic, and map snapshot diffs.", "name": "Diagnostics" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }