Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.
/accounts/{account_identifier}/dex/traceroute-tests/{test_id}
get
DEX Synthetic Application Montitoring
dex-endpoints-traceroute-test-details
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": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.",
"in": "query",
"name": "deviceId",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"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"
}
},
{
"description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.",
"in": "query",
"name": "colo",
"schema": {
"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": {
"host": {
"description": "The host of the Traceroute synthetic application test",
"example": "1.1.1.1",
"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": {
"description": "The name of the Traceroute synthetic application test",
"example": "Atlassian Sign In Page",
"type": "string"
},
"tracerouteStats": {
"nullable": true,
"properties": {
"availabilityPct": {
"properties": {
"avg": {
"description": "average observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"max": {
"description": "highest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"min": {
"description": "lowest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"format": "float",
"type": "number"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"hopsCount": {
"properties": {
"avg": {
"description": "average observed in the time period",
"nullable": true,
"type": "integer"
},
"max": {
"description": "highest observed in the time period",
"nullable": true,
"type": "integer"
},
"min": {
"description": "lowest observed in the time period",
"nullable": true,
"type": "integer"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"packetLossPct": {
"properties": {
"avg": {
"description": "average observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"max": {
"description": "highest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"min": {
"description": "lowest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"format": "float",
"type": "number"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"roundTripTimeMs": {
"properties": {
"avg": {
"description": "average observed in the time period",
"nullable": true,
"type": "integer"
},
"max": {
"description": "highest observed in the time period",
"nullable": true,
"type": "integer"
},
"min": {
"description": "lowest observed in the time period",
"nullable": true,
"type": "integer"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"uniqueDevicesTotal": {
"description": "Count of unique devices that have run this test in the given time period",
"example": 57,
"type": "integer"
}
},
"required": [
"uniqueDevicesTotal",
"roundTripTimeMs",
"hopsCount",
"packetLossPct",
"availabilityPct"
],
"type": "object"
},
"tracerouteStatsByColo": {
"items": {
"properties": {
"availabilityPct": {
"properties": {
"avg": {
"description": "average observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"max": {
"description": "highest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"min": {
"description": "lowest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"format": "float",
"type": "number"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"colo": {
"example": "DFW",
"type": "string"
},
"hopsCount": {
"properties": {
"avg": {
"description": "average observed in the time period",
"nullable": true,
"type": "integer"
},
"max": {
"description": "highest observed in the time period",
"nullable": true,
"type": "integer"
},
"min": {
"description": "lowest observed in the time period",
"nullable": true,
"type": "integer"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"packetLossPct": {
"properties": {
"avg": {
"description": "average observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"max": {
"description": "highest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"min": {
"description": "lowest observed in the time period",
"format": "float",
"nullable": true,
"type": "number"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"format": "float",
"type": "number"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"roundTripTimeMs": {
"properties": {
"avg": {
"description": "average observed in the time period",
"nullable": true,
"type": "integer"
},
"max": {
"description": "highest observed in the time period",
"nullable": true,
"type": "integer"
},
"min": {
"description": "lowest observed in the time period",
"nullable": true,
"type": "integer"
},
"slots": {
"items": {
"properties": {
"timestamp": {
"example": "2023-07-16 15:00:00+00",
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"timestamp",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"slots"
],
"type": "object"
},
"uniqueDevicesTotal": {
"description": "Count of unique devices that have run this test in the given time period",
"example": 57,
"type": "integer"
}
},
"required": [
"colo",
"uniqueDevicesTotal",
"roundTripTimeMs",
"hopsCount",
"packetLossPct",
"availabilityPct"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"kind",
"name",
"host",
"interval"
],
"type": "object"
}
}
}
]
}
}
},
"description": "DEX traceroute test details 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 details response failure response"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]