Get a breakdown of hops and performance metrics for a specific traceroute test run
/accounts/{account_identifier}/dex/traceroute-test-results/{test_result_id}/network-path
get
DEX Synthetic Application Montitoring
dex-endpoints-traceroute-test-result-network-path
null{
"enum": [
"#dex:read",
"#teams:report"
]
}[
{
"description": "unique identifier linked to an account",
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"example": "01a7362d577a6c3019a474fd6f485823",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"description": "unique identifier for a specific traceroute test",
"in": "path",
"name": "test_result_id",
"required": true,
"schema": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"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": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"testId": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"testName": {
"description": "name of the tracroute test",
"type": "string"
},
"time_start": {
"description": "date time of this traceroute test",
"example": "2023-07-16 15:00:00+00",
"type": "string"
}
},
"required": [
"resultId",
"time_start",
"hops"
],
"type": "object"
}
}
}
]
}
}
},
"description": "DEX traceroute test result network path response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "DEX traceroute test result network path failure response"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]