Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DEX

Traceroute Tests

Get details and aggregate metrics for a traceroute test
client.zeroTrust.dex.tracerouteTests.get(stringtestID, TracerouteTestGetParams { account_id, from, interval, 3 more } params, RequestOptionsoptions?): Traceroute { host, interval, kind, 5 more }
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}
Get percentiles for a traceroute test
client.zeroTrust.dex.tracerouteTests.percentiles(stringtestID, TracerouteTestPercentilesParams { account_id, from, to, 2 more } params, RequestOptionsoptions?): TracerouteTestPercentilesResponse { hopsCount, packetLossPct, roundTripTimeMs }
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles
Get network path breakdown for a traceroute test
client.zeroTrust.dex.tracerouteTests.networkPath(stringtestID, TracerouteTestNetworkPathParams { account_id, deviceId, from, 2 more } params, RequestOptionsoptions?): NetworkPathResponse { id, deviceName, interval, 4 more }
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path
ModelsExpand Collapse
Traceroute { host, interval, kind, 5 more }
host: string

The host of the Traceroute synthetic application test.

interval: string

The interval at which the Traceroute synthetic application test is set to run.

kind: "traceroute"
name: string

The name of the Traceroute synthetic application test.

target_policies?: Array<DigitalExperienceMonitor { id, default, name } > | null
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account.

name: string
targeted?: boolean
tracerouteStats?: TracerouteStats | null
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
hopsCount: TestStatOverTime { slots, avg, max, min }
packetLossPct: PacketLossPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
roundTripTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

tracerouteStatsByColo?: Array<TracerouteStatsByColo>
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
colo: string
hopsCount: TestStatOverTime { slots, avg, max, min }
packetLossPct: PacketLossPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
roundTripTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

TracerouteTestPercentilesResponse { hopsCount, packetLossPct, roundTripTimeMs }
hopsCount?: Percentiles { p50, p90, p95, p99 }
packetLossPct?: Percentiles { p50, p90, p95, p99 }
roundTripTimeMs?: Percentiles { p50, p90, p95, p99 }