digital-experience-monitoring_http_details_response

APIs.ioEngineeringPlatform

Properties

Name Type Description
host string The url of the HTTP synthetic application test
httpStats object
httpStatsByColo array
interval string The interval at which the HTTP synthetic application test is set to run.
kind object
method string The HTTP method to use when running the test
name string The name of the HTTP synthetic application test
target_policies array
targeted boolean
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-digital-experience-monitoring-http-details-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/digital-experience-monitoring_http_details_response",
  "title": "digital-experience-monitoring_http_details_response",
  "properties": {
    "host": {
      "description": "The url of the HTTP synthetic application test",
      "example": "http://example.com",
      "type": "string"
    },
    "httpStats": {
      "nullable": true,
      "properties": {
        "availabilityPct": {
          "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"
        },
        "dnsResponseTimeMs": {
          "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
        },
        "httpStatusCode": {
          "items": {
            "properties": {
              "status200": {
                "type": "integer"
              },
              "status300": {
                "type": "integer"
              },
              "status400": {
                "type": "integer"
              },
              "status500": {
                "type": "integer"
              },
              "timestamp": {
                "example": "2023-07-16 15:00:00+00:00",
                "type": "string"
              }
            },
            "required": [
              "timestamp",
              "status200",
              "status300",
              "status400",
              "status500"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "resourceFetchTimeMs": {
          "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
        },
        "serverResponseTimeMs": {
          "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
        },
        "uniqueDevicesTotal": {
          "description": "Count of unique devices that have run this test in the given time period",
          "example": 57,
          "type": "integer"
        }
      },
      "required": [
        "uniqueDevicesTotal",
        "resourceFetchTimeMs",
        "serverResponseTimeMs",
        "dnsResponseTimeMs",
        "httpStatusCode",
        "availabilityPct"
      ],
      "type": "object"
    },
    "httpStatsByColo": {
      "items": {
        "properties": {
          "availabilityPct": {
            "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"
          },
          "colo": {
            "example": "DFW",
            "type": "string"
          },
          "dnsResponseTimeMs": {
            "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
          },
          "httpStatusCode": {
            "items": {
              "properties": {
                "status200": {
                  "type": "integer"
                },
                "status300": {
                  "type": "integer"
                },
                "status400": {
                  "type": "integer"
                },
                "status500": {
                  "type": "integer"
                },
                "timestamp": {
                  "example": "2023-07-16 15:00:00+00:00",
                  "type": "string"
                }
              },
              "required": [
                "timestamp",
                "status200",
                "status300",
                "status400",
                "status500"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "resourceFetchTimeMs": {
            "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
          },
          "serverResponseTimeMs": {
            "$ref": "#/components/schemas/digital-experience-monitoring_test_stat_over_time"
          },
          "uniqueDevicesTotal": {
            "description": "Count of unique devices that have run this test in the given time period",
            "example": 57,
            "type": "integer"
          }
        },
        "required": [
          "colo",
          "uniqueDevicesTotal",
          "resourceFetchTimeMs",
          "serverResponseTimeMs",
          "dnsResponseTimeMs",
          "httpStatusCode",
          "availabilityPct"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "interval": {
      "description": "The interval at which the HTTP synthetic application test is set to run.",
      "example": "0h5m0s",
      "type": "string"
    },
    "kind": {
      "enum": [
        "http"
      ]
    },
    "method": {
      "description": "The HTTP method to use when running the test",
      "example": "GET",
      "type": "string"
    },
    "name": {
      "description": "The name of the HTTP synthetic application test",
      "example": "Atlassian Sign In Page",
      "type": "string"
    },
    "target_policies": {
      "items": {
        "properties": {
          "default": {
            "description": "Whether the policy is the default for the account",
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "default"
        ],
        "type": "object"
      },
      "nullable": true,
      "type": "array"
    },
    "targeted": {
      "type": "boolean"
    }
  },
  "type": "object"
}