{ "components": { "schemas": { "schema-get-agent-groups-200": { "description": "Represents the set of possible agents in which tests for a given SLA test configuration are run. Agents groups are defined by geographical location. This setting usually corresponds to the regional SLA provided to you with your purchase.", "items": { "additionalProperties": false, "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "name": { "description": "Descriptive name of an agent group indicating its geographical region.", "minLength": 1, "type": "string" } }, "required": [ "agentGroupId", "name" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true, "x-akamai": { "file-path": "schemas/schema-get-agent-groups-200.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference" }, "info": { "description": "Access the SLA test configurations and the resulting reports.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Service-Level Agreement API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/agent-groups": { "get": { "description": "This returns an array of all agent group identifiers and their corresponding descriptions. You can use this to retrieve a human-readable equivalent of the `agentGroupId` numbers.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-agent-groups" }, "operationId": "get-agent-groups", "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": [ { "agentGroupId": 1, "name": "Australia SLA" }, { "agentGroupId": 5, "name": "North American SLA" } ], "schema": { "description": "Represents the set of possible agents in which tests for a given SLA test configuration are run. Agents groups are defined by geographical location. This setting usually corresponds to the regional SLA provided to you with your purchase.", "items": { "additionalProperties": false, "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "name": { "description": "Descriptive name of an agent group indicating its geographical region.", "minLength": 1, "type": "string" } }, "required": [ "agentGroupId", "name" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true, "x-akamai": { "file-path": "schemas/schema-get-agent-groups-200.yaml" } } } }, "description": "OK." } }, "summary": "List agent groups", "tags": [ "Agent Groups" ] }, "x-akamai": { "file-path": "paths/agent-groups.yaml", "path-info": "/agent-groups" } }, "/test-quotas": { "get": { "description": "Each contract has a maximum number of allowed test configurations. Get the test quotas to find out how many test configurations are allowed and how many are in use.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-quotas" }, "operationId": "get-quotas", "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": [ { "availabilitySlaCounts": { "max": 1, "used": 0 }, "contractId": "C-0N7RAC71", "performanceSlaCounts": { "max": 1, "used": 0 } } ], "schema": { "description": "Each contract has a maximum number of allowed test configurations. The quota object indicates how many test configurations are allowed on the specified contract and how many are in use.", "items": { "additionalProperties": false, "properties": { "availabilitySlaCounts": { "additionalProperties": false, "description": "Bundles quota data for availability test configurations.", "properties": { "max": { "description": "The maximum number of allowed test configurations of the specified type.", "type": "integer" }, "used": { "description": "The number of test configurations of the specified type that are currently used.", "type": "integer" } }, "required": [ "used", "max" ], "type": "object" }, "contractId": { "description": "The contract for which you want to get quota data.", "minLength": 1, "type": "string" }, "performanceSlaCounts": { "additionalProperties": false, "description": "Bundles quota data for performance test configurations.", "properties": { "max": { "description": "The maximum number of allowed test configurations of the specified type.", "type": "integer" }, "used": { "description": "The number of test configurations of the specified type that are currently used.", "type": "integer" } }, "required": [ "used", "max" ], "type": "object" } }, "required": [ "contractId", "availabilitySlaCounts", "performanceSlaCounts" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true, "x-akamai": { "file-path": "schemas/schema-get-quotas-200.yaml" } } } }, "description": "OK." } }, "summary": "List test configuration quotas", "tags": [ "Quotas" ] }, "x-akamai": { "file-path": "paths/test-quotas.yaml", "path-info": "/test-quotas" } }, "/tests": { "post": { "description": "Create either a new availability test configuration or a new performance test configuration, if there is an available corresponding slot in the contract's quotas.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/post-test-config" }, "operationId": "post-test-config", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "agentGroupId": 123, "contractId": "K-0N7RAK71", "groupId": 54321, "name": "My Test Name", "performanceSlaTarget": 1.1, "testDetails": { "akamaiUrl": "http://www.example.com/testObject.txt", "originDnsHostnameOverride": "unpredictablestring-www.example.com", "originUrl": "http://www.example.com/testObject.txt" }, "type": "PERFORMANCE" }, "schema": { "additionalProperties": false, "description": "Represents a configuration of either an availability test or a performance test. You can use a test object to add a new test configuration, update an existing one, or get the settings of a specified configuration.", "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "contractId": { "description": "The contract associated with the test configuration.", "minLength": 1, "type": "string" }, "groupId": { "description": "Identifies the group containing the property. See the [Property Manager API](https://techdocs.akamai.com/property-mgr/reference) (PAPI), which provides these IDs. Required when creating a test configuration.", "type": "integer" }, "name": { "description": "Name you create to identify test configurations and their associated reports.", "minLength": 1, "type": "string" }, "performanceSlaTarget": { "description": "The target performance as specified in the SLA, expressed as a decimal greater than or equal to 1.0. For a target performance improvement of 20%, specify 1.2.", "type": "number" }, "testDetails": { "additionalProperties": false, "description": "Contains test object location and hostnames.", "properties": { "akamaiUrl": { "description": "The URL of the test object for the CDN portion of the test.", "minLength": 1, "type": "string" }, "originDnsHostnameOverride": { "description": "Replaces the hostname in `originUrl` for the purposes of DNS lookup to obtain the IP address of the origin server. Use this if requests sent directly to your origin hostname redirect to the CDN.", "minLength": 1, "type": "string" }, "originUrl": { "description": "The URL of the test object for the origin portion of the test. Use the outward-facing hostname if `originDnsHostnameOverride` is included, otherwise use the origin hostname.", "minLength": 1, "type": "string" } }, "required": [ "originUrl", "akamaiUrl", "originDnsHostnameOverride" ], "type": "object" }, "type": { "description": "The test configuration type, either `PERFORMANCE` or `AVAILABILITY`.", "enum": [ "PERFORMANCE", "AVAILABILITY" ], "minLength": 1, "type": "string" } }, "required": [ "groupId", "contractId", "agentGroupId", "name", "type", "performanceSlaTarget", "testDetails" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-post-test-config.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "slaTestId": 82 }, "schema": { "additionalProperties": false, "description": "Represents a configuration of either an availability test or a performance test. A test object can be used to add a new test configuration, update an existing one, or get the settings of a specified configuration.", "properties": { "slaTestId": { "description": "Identifies each test configuration.", "type": "integer" } }, "required": [ "slaTestId" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-post-test-config-201.yaml" } } } }, "description": "Successfully created." } }, "summary": "Create a new test configuration", "tags": [ "Create Test" ] }, "get": { "description": "Returns all test configurations, or a filtered set you use the `slaTestIds` parameter to control.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-test-configs" }, "operationId": "get-test-configs", "parameters": [ { "description": "One or more IDs of SLA tests, comma separated.", "in": "query", "name": "slaTestIds", "schema": { "example": "82,83", "type": "string" }, "x-akamai": { "file-path": "parameters/sla-test-ids-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": [ { "agentGroupId": 123, "contractId": "K-0N7RAK71", "name": "My Test Name", "performanceSlaTarget": 1.1, "slaTestId": 82, "testDetails": { "akamaiUrl": "http://www.example.com/testObject.txt", "originDnsHostnameOverride": "unpredictablestring-www.example.com", "originUrl": "http://www.example.com/testObject.txt" }, "type": "PERFORMANCE" }, { "agentGroupId": 124, "contractId": "C-0N7RAC71", "name": "My Second Test Name", "performanceSlaTarget": 1.1, "slaTestId": 83, "testDetails": { "akamaiUrl": "http://www.example.com/testObject.txt", "originDnsHostnameOverride": "unpredictablestring-www.example.com", "originUrl": "http://www.example.com/testObject.txt" }, "type": "PERFORMANCE" } ], "schema": { "description": "Represents configurations for either an availability test or a performance test. You can use a test object to add a new test configuration, update an existing one, or get the settings of a specified configuration.", "items": { "additionalProperties": false, "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "contractId": { "description": "The contract associated with the test configuration.", "minLength": 1, "type": "string" }, "name": { "description": "Name you create to identify test configurations and their associated reports.", "minLength": 1, "type": "string" }, "performanceSlaTarget": { "description": "The target performance as specified in the SLA, expressed as a decimal greater than or equal to 1.0. For a target performance improvement of 20%, specify 1.2.", "type": "number" }, "slaTestId": { "description": "Identifies each test configuration.", "type": "integer" }, "testDetails": { "additionalProperties": false, "description": "Contains test object location and hostnames.", "properties": { "akamaiUrl": { "description": "The URL of the test object for the CDN portion of the test.", "minLength": 1, "type": "string" }, "originDnsHostnameOverride": { "description": "Replaces the hostname in `originUrl` for the purposes of DNS lookup to obtain the IP address of the origin server. Use this if requests sent directly to your origin hostname redirect to the CDN.", "minLength": 1, "type": "string" }, "originUrl": { "description": "The URL of the test object for the origin portion of the test. Use the outward-facing hostname if `originDnsHostnameOverride` is included, otherwise use the origin hostname.", "minLength": 1, "type": "string" } }, "required": [ "originUrl", "akamaiUrl", "originDnsHostnameOverride" ], "type": "object" }, "type": { "description": "The test configuration type, either `PERFORMANCE` or `AVAILABILITY`.", "enum": [ "PERFORMANCE", "AVAILABILITY" ], "minLength": 1, "type": "string" } }, "required": [ "slaTestId", "contractId", "agentGroupId", "name", "type", "performanceSlaTarget", "testDetails" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true, "x-akamai": { "file-path": "schemas/schema-get-test-configs-200.yaml" } } } }, "description": "OK." } }, "summary": "List test configurations", "tags": [ "Tests" ] }, "x-akamai": { "file-path": "paths/tests.yaml", "path-info": "/tests" } }, "/tests/{slaTestId}": { "get": { "description": "Return the contents of one test configuration. Set the `slaTestId` parameter to indicate which test configuration to retrieve.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-test-config" }, "operationId": "get-test-config", "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": { "agentGroupId": 123, "contractId": "C-0N7RAC7", "name": "My Test Name", "performanceSlaTarget": 1.1, "slaTestId": 82, "testDetails": { "akamaiUrl": "http://www.example.com/testObject.txt", "originDnsHostnameOverride": "unpredictablestring-www.example.com", "originUrl": "http://www.example.com/testObject.txt" }, "type": "PERFORMANCE" }, "schema": { "additionalProperties": false, "description": "Represents a configuration of either an availability test or a performance test. You an use a test object to add a new test configuration, update an existing one, or get the settings of a specified configuration.", "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "contractId": { "description": "The contract associated with the test configuration.", "minLength": 1, "type": "string" }, "name": { "description": "Name you create to identify test configurations and their associated reports.", "minLength": 1, "type": "string" }, "performanceSlaTarget": { "description": "The target performance as specified in the SLA, expressed as a decimal greater than or equal to 1.0. For a target performance improvement of 20%, specify 1.2.", "type": "number" }, "slaTestId": { "description": "Identifies each test configuration.", "type": "integer" }, "testDetails": { "additionalProperties": false, "description": "Contains test object location and hostnames.", "properties": { "akamaiUrl": { "description": "The URL of the test object for the CDN portion of the test.", "minLength": 1, "type": "string" }, "originDnsHostnameOverride": { "description": "Replaces the hostname in `originUrl` for the purposes of DNS lookup to obtain the IP address of the origin server. Use this if requests sent directly to your origin hostname redirect to the CDN.", "minLength": 1, "type": "string" }, "originUrl": { "description": "The URL of the test object for the origin portion of the test. Use the outward-facing hostname if `originDnsHostnameOverride` is included, otherwise use the origin hostname.", "minLength": 1, "type": "string" } }, "required": [ "originUrl", "akamaiUrl", "originDnsHostnameOverride" ], "type": "object" }, "type": { "description": "The test configuration type, either `PERFORMANCE` or `AVAILABILITY`.", "enum": [ "PERFORMANCE", "AVAILABILITY" ], "minLength": 1, "type": "string" } }, "required": [ "slaTestId", "contractId", "agentGroupId", "name", "type", "performanceSlaTarget", "testDetails" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-get-test-config-200.yaml" } } } }, "description": "OK." } }, "summary": "Get a test configuration", "tags": [ "Tests" ] }, "put": { "description": "Use this operation change an existing test configuration, such as changing the agent group or adding a performance target. Set the `slaTestId` parameter to indicate which test configuration to update.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/put-test-config" }, "operationId": "put-test-config", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "agentGroupId": 123, "contractId": "C-0N7RAC7", "name": "My Test Name", "performanceSlaTarget": 1.1, "testDetails": { "akamaiUrl": "http://www.example.com/testObject.txt", "originDnsHostnameOverride": "unpredictablestring-www.example.com", "originUrl": "http://www.example.com/testObject.txt" }, "type": "PERFORMANCE" }, "schema": { "additionalProperties": false, "description": "Represents a configuration of either an availability test or a performance test. You can use a test object to add a new test configuration, update an existing one, or get the settings of a specified configuration.", "properties": { "agentGroupId": { "description": "Code representing the agent group (also called a region or regional SLA) for the test configuration. See [agentGroupId values](https://techdocs.akamai.com/sla/reference/agentgroupid-values).", "type": "integer" }, "contractId": { "description": "The contract associated with the test configuration.", "type": "string" }, "name": { "description": "Name you create to identify test configurations and their associated reports.", "type": "string" }, "performanceSlaTarget": { "description": "The target performance as specified in the SLA, expressed as a decimal greater than or equal to 1.0. For a target performance improvement of 20%, specify 1.2.", "type": "number" }, "testDetails": { "additionalProperties": false, "description": "Contains test object location and hostnames.", "properties": { "akamaiUrl": { "description": "The URL of the test object for the CDN portion of the test.", "type": "string" }, "originDnsHostnameOverride": { "description": "Replaces the hostname in `originUrl` for the purposes of DNS lookup to obtain the IP address of the origin server. Use this if requests sent directly to your origin hostname redirect to the CDN.", "type": "string" }, "originUrl": { "description": "The URL of the test object for the origin portion of the test. Use the outward-facing hostname if `originDnsHostnameOverride` is included, otherwise use the origin hostname.", "type": "string" } }, "required": [ "originUrl", "akamaiUrl", "originDnsHostnameOverride" ], "type": "object" }, "type": { "description": "The test configuration type, either `PERFORMANCE` or `AVAILABILITY`.", "enum": [ "PERFORMANCE", "AVAILABILITY" ], "type": "string" } }, "required": [ "contractId", "agentGroupId", "name", "type", "performanceSlaTarget", "testDetails" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-put-test-config.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "OK." } }, "summary": "Update a test configuration", "tags": [ "Tests" ] }, "delete": { "description": "Deletion cannot be undone. Once you delete a test configuration, you can't retrieve it or any data that it has collected. Set the `slaTestId` parameter to indicate which test configuration to delete.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/delete-test-config" }, "operationId": "delete-test-config", "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": {}, "description": "OK." } }, "summary": "Delete a test configuration", "tags": [ "Tests" ] }, "parameters": [ { "description": "The test's unique identifier.", "in": "path", "name": "slaTestId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/sla-test-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sla-test.yaml", "path-info": "/tests/{slaTestId}" } }, "/tests/{slaTestId}/reports/availability": { "get": { "description": "Returns an array of the results of availability tests run in the specified time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-availability-reports" }, "operationId": "get-availability-reports", "parameters": [ { "description": "Timestamp for the start of the data window, in UTC 8601 format.", "in": "query", "name": "start", "required": true, "schema": { "example": "2016-03-09T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "Timestamp for the end of data window, in UTC 8601 format.", "in": "query", "name": "end", "required": true, "schema": { "example": "2016-03-12T01:00:00Z", "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": { "akamaiTestErrors": [ { "agentIp": "192.0.2.55", "agentName": "Frankfurt, Germany", "time": "2016-03-09T03:29:25Z" }, { "agentIp": "192.0.2.193", "agentName": "Berlin, Germany", "time": "2016-03-09T08:20:11Z" }, { "agentIp": "192.0.2.31", "agentName": "Paris, France", "time": "2016-03-09T09:31:37Z" } ], "estimatedAvailabilityPercentage": 1, "originTestErrors": [ { "agentIp": "192.0.2.164", "agentName": "Frankfurt, Germany", "time": "2016-03-09T03:29:25Z" }, { "agentIp": "192.0.2.71", "agentName": "Berlin, Germany", "time": "2016-03-09T08:20:11Z" }, { "agentIp": "192.0.2.209", "agentName": "Paris, France", "time": "2016-03-09T09:31:37Z" } ] }, "schema": { "additionalProperties": false, "description": "Represents the results of availability testing for the specified date range.", "properties": { "akamaiTestErrors": { "description": "Instances of the CDN test that reported failures.", "items": { "additionalProperties": false, "description": "This object is referenced by both the `originTestErrors` and `akamaiTestErrors` members.", "properties": { "agentIp": { "description": "The IP address of the agent.", "minLength": 1, "type": "string" }, "agentName": { "description": "The geographical location of the agent used in an origin or CDN availability test that failed.", "minLength": 1, "type": "string" }, "time": { "description": "Time the error occurred, in ISO 8601 UTC format.", "minLength": 1, "type": "string" } }, "required": [ "agentName", "agentIp", "time" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true }, "estimatedAvailabilityPercentage": { "description": "Estimated time range for which no potential outage was detected, expressed as a decimal range from 0 to 1.", "maximum": 1, "minimum": 0, "type": "number" }, "originTestErrors": { "description": "Instances of the origin test that reported failures.", "items": { "additionalProperties": false, "description": "This object is referenced by both the `originTestErrors` and `akamaiTestErrors` members.", "properties": { "agentIp": { "description": "The IP address of the agent.", "minLength": 1, "type": "string" }, "agentName": { "description": "The geographical location of the agent used in an origin or CDN availability test that failed.", "minLength": 1, "type": "string" }, "time": { "description": "Time the error occurred, in ISO 8601 UTC format.", "minLength": 1, "type": "string" } }, "required": [ "agentName", "agentIp", "time" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "estimatedAvailabilityPercentage", "originTestErrors", "akamaiTestErrors" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-get-availability-reports-200.yaml" } } } }, "description": "OK." } }, "summary": "List availability reports", "tags": [ "Reports" ] }, "parameters": [ { "description": "The test's unique identifier.", "in": "path", "name": "slaTestId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/sla-test-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/availability.yaml", "path-info": "/tests/{slaTestId}/reports/availability" } }, "/tests/{slaTestId}/reports/performance": { "get": { "description": "Returns an array of the results of performance tests run in the specified time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Service-Level Agreement API", "url": "https://techdocs.akamai.com/sla/reference/get-performance-reports" }, "operationId": "get-performance-reports", "parameters": [ { "description": "Timestamp for the start of the data window, in UTC 8601 format.", "in": "query", "name": "start", "required": true, "schema": { "example": "2016-03-09T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "Timestamp for the end of data window, in UTC 8601 format.", "in": "query", "name": "end", "required": true, "schema": { "example": "2016-03-12T01:00:00Z", "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": { "data": [ { "averageAkamaiPerformanceGain": 1.2573270808909731, "averageResponseTimeAkamai": 1706, "averageResponseTimeOrigin": 2145, "date": "2016-03-09", "numberOfAkamaiTests": 1385, "numberOfOriginTests": 1385 }, { "averageAkamaiPerformanceGain": 1.1373414230557088, "averageResponseTimeAkamai": 1813, "averageResponseTimeOrigin": 2062, "date": "2016-03-10", "numberOfAkamaiTests": 1329, "numberOfOriginTests": 1329 }, { "averageAkamaiPerformanceGain": 1.3577405857740585, "averageResponseTimeAkamai": 1434, "averageResponseTimeOrigin": 1947, "date": "2016-03-11", "numberOfAkamaiTests": 1245, "numberOfOriginTests": 1245 } ] }, "schema": { "additionalProperties": false, "description": "Represents the performance test results for the specified date range. Each item in the `data` array contains aggregate performance data for one calendar day.", "properties": { "data": { "description": "Container for instances of performance report data.", "items": { "additionalProperties": false, "description": "Each day's data.", "properties": { "averageAkamaiPerformanceGain": { "description": "The average of all performance gains for the specified date. Each is the `averageResponseTimeOrigin` divided by the `averageResponseTimeAkamai`.", "type": "number" }, "averageResponseTimeAkamai": { "description": "The average of all CDN test times in milliseconds measured on the specified date.", "type": "number" }, "averageResponseTimeOrigin": { "description": "The average of all origin test times in milliseconds measured on the specified date.", "type": "number" }, "date": { "description": "The day of each summary test, expressed as an ISO 8601 date stamp.", "minLength": 1, "type": "string" }, "numberOfAkamaiTests": { "description": "The number of CDN performance test measurements included in the aggregation.", "type": "integer" }, "numberOfOriginTests": { "description": "The number of origin performance test measurements included in the aggregation.", "type": "integer" } }, "required": [ "date", "averageAkamaiPerformanceGain", "numberOfAkamaiTests", "numberOfOriginTests", "averageResponseTimeOrigin", "averageResponseTimeAkamai" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "data" ], "type": "object", "x-akamai": { "file-path": "schemas/schema-get-performance-reports-200.yaml" } } } }, "description": "OK." } }, "summary": "List performance reports", "tags": [ "Reports" ] }, "parameters": [ { "description": "The test's unique identifier.", "in": "path", "name": "slaTestId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/sla-test-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/performance.yaml", "path-info": "/tests/{slaTestId}/reports/performance" } } }, "servers": [ { "url": "https://{hostname}/sla-api/v1" } ], "tags": [ { "description": "Groups operations that you can use to get details of agent groups.", "name": "Agent groups" }, { "description": "Groups operations that you can use to get details of contract quotas.", "name": "Quotas" }, { "description": "Groups operations that you can use to manage test configurations.", "name": "Tests" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }