Get a breakdown of metrics by hop for individual traceroute test runs
/accounts/{account_identifier}/dex/traceroute-tests/{test_id}/network-path
get
DEX Synthetic Application Montitoring
dex-endpoints-traceroute-test-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 test",
"in": "path",
"name": "test_id",
"required": true,
"schema": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
}
},
{
"description": "Device to filter tracroute result runs to",
"in": "query",
"name": "deviceId",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Start time for aggregate metrics in ISO ms",
"in": "query",
"name": "timeStart",
"required": true,
"schema": {
"example": 1689520412000,
"type": "string"
}
},
{
"description": "End time for aggregate metrics in ISO ms",
"in": "query",
"name": "timeEnd",
"required": true,
"schema": {
"example": 1689606812000,
"type": "string"
}
},
{
"description": "Time interval for aggregate time slots.",
"in": "query",
"name": "interval",
"required": true,
"schema": {
"enum": [
"minute",
"hour"
],
"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": {
"type": "string"
},
"id": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"interval": {
"description": "The interval at which the Traceroute synthetic application test is set to run.",
"example": "0h5m0s",
"type": "string"
},
"kind": {
"enum": [
"traceroute"
]
},
"name": {
"type": "string"
},
"networkPath": {
"nullable": true,
"properties": {
"sampling": {
"description": "Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.",
"nullable": true,
"properties": {
"unit": {
"enum": [
"hours"
]
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"unit"
],
"type": "object"
},
"slots": {
"items": {
"properties": {
"clientToAppRttMs": {
"description": "Round trip time in ms of the client to app mile",
"nullable": true,
"type": "integer"
},
"clientToCfEgressRttMs": {
"description": "Round trip time in ms of the client to Cloudflare egress mile",
"nullable": true,
"type": "integer"
},
"clientToCfIngressRttMs": {
"description": "Round trip time in ms of the client to Cloudflare ingress mile",
"nullable": true,
"type": "integer"
},
"clientToIspRttMs": {
"description": "Round trip time in ms of the client to ISP mile",
"nullable": true,
"type": "integer"
},
"id": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
}
},
"required": [
"id",
"timestamp",
"clientToAppRttMs",
"clientToCfIngressRttMs",
"clientToCfEgressRttMs"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"url": {
"description": "The host of the Traceroute synthetic application test",
"example": "1.1.1.1",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
}
}
]
}
}
},
"description": "DEX traceroute test 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 network path failure response"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]