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

Tests

List DEX test analytics
client.zeroTrust.dex.tests.list(TestListParams { account_id, colo, deviceId, 4 more } params, RequestOptionsoptions?): V4PagePagination<Tests { overviewMetrics, tests } >
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
AggregateTimePeriod { units, value }
units: "hours" | "days" | "testRuns"
One of the following:
"hours"
"days"
"testRuns"
value: number
Tests { overviewMetrics, tests }
overviewMetrics: OverviewMetrics { testsTotal, avgHttpAvailabilityPct, avgTracerouteAvailabilityPct }
testsTotal: number

number of tests.

avgHttpAvailabilityPct?: number | null

percentage availability for all HTTP test results in response

formatfloat
avgTracerouteAvailabilityPct?: number | null

percentage availability for all traceroutes results in response

formatfloat
tests: Array<Test>

array of test results objects.

id: string

API Resource UUID tag.

maxLength36
created: string

date the test was created.

description: string

the test description defined during configuration

enabled: boolean

if true, then the test will run on targeted devices. Else, the test will not run.

host: string
interval: string

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

kind: "http" | "traceroute"

test type, http or traceroute

One of the following:
"http"
"traceroute"
name: string

name given to this test

updated: string
httpResults?: HTTPResults | null
resourceFetchTime: ResourceFetchTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
httpResultsByColo?: Array<HTTPResultsByColo>
colo: string

Cloudflare colo

resourceFetchTime: ResourceFetchTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
method?: string

for HTTP, the method to use when running the 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
tracerouteResults?: TracerouteResults | null
roundTripTime: RoundTripTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
tracerouteResultsByColo?: Array<TracerouteResultsByColo>
colo: string

Cloudflare colo

roundTripTime: RoundTripTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string

TestsUnique Devices

Get count of devices targeted
client.zeroTrust.dex.tests.uniqueDevices.list(UniqueDeviceListParams { account_id, deviceId, testName } params, RequestOptionsoptions?): UniqueDevices { uniqueDevicesTotal }
GET/accounts/{account_id}/dex/tests/unique-devices
ModelsExpand Collapse
UniqueDevices { uniqueDevicesTotal }
uniqueDevicesTotal: number

total number of unique devices