digital-experience-monitoring_traceroute_test_result_network_path_response

APIs.ioEngineeringPlatform

Properties

Name Type Description
deviceName string name of the device associated with this network path response
hops array an array of the hops taken by the device to reach the end destination
resultId object
testId object
testName string name of the tracroute test
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-digital-experience-monitoring-traceroute-test-result-network-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/digital-experience-monitoring_traceroute_test_result_network_path_response",
  "title": "digital-experience-monitoring_traceroute_test_result_network_path_response",
  "properties": {
    "deviceName": {
      "description": "name of the device associated with this network path response",
      "type": "string"
    },
    "hops": {
      "description": "an array of the hops taken by the device to reach the end destination",
      "items": {
        "properties": {
          "asn": {
            "nullable": true,
            "type": "integer"
          },
          "aso": {
            "nullable": true,
            "type": "string"
          },
          "ipAddress": {
            "nullable": true,
            "type": "string"
          },
          "location": {
            "nullable": true,
            "properties": {
              "city": {
                "nullable": true,
                "type": "string"
              },
              "state": {
                "nullable": true,
                "type": "string"
              },
              "zip": {
                "nullable": true,
                "type": "string"
              }
            },
            "type": "object"
          },
          "mile": {
            "enum": [
              "client-to-app",
              "client-to-cf-egress",
              "client-to-cf-ingress",
              "client-to-isp"
            ],
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "packetLossPct": {
            "format": "float",
            "nullable": true,
            "type": "number"
          },
          "rttMs": {
            "nullable": true,
            "type": "integer"
          },
          "ttl": {
            "type": "integer"
          }
        },
        "required": [
          "ttl"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "resultId": {
      "$ref": "#/components/schemas/digital-experience-monitoring_uuid"
    },
    "testId": {
      "$ref": "#/components/schemas/digital-experience-monitoring_uuid"
    },
    "testName": {
      "description": "name of the tracroute test",
      "type": "string"
    }
  },
  "required": [
    "resultId",
    "hops"
  ],
  "type": "object"
}