Skip to content
Start here

Tests

List DEX test analytics
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
AggregateTimePeriod { units, value }
units: "hours" or "days" or "testRuns"
One of the following:
"hours"
"days"
"testRuns"
value: number
Tests { overviewMetrics, tests }
overviewMetrics: { testsTotal, avgHttpAvailabilityPct, avgTracerouteAvailabilityPct }
testsTotal: number

number of tests.

avgHttpAvailabilityPct: optional number

percentage availability for all HTTP test results in response

formatfloat
avgTracerouteAvailabilityPct: optional number

percentage availability for all traceroutes results in response

formatfloat
tests: array of { id, created, description, 13 more }

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" or "traceroute"

test type, http or traceroute

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

name given to this test

updated: string
httpResults: optional { resourceFetchTime }
resourceFetchTime: { history, avgMs, overTime }
history: array of { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of { avgMs, timestamp }
avgMs: number
timestamp: string
httpResultsByColo: optional array of { colo, resourceFetchTime }
colo: string

Cloudflare colo

resourceFetchTime: { history, avgMs, overTime }
history: array of { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of { avgMs, timestamp }
avgMs: number
timestamp: string
method: optional string

for HTTP, the method to use when running the test

target_policies: optional array of DigitalExperienceMonitor { id, default, name }
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account

name: string
targeted: optional boolean
tracerouteResults: optional { roundTripTime }
roundTripTime: { history, avgMs, overTime }
history: array of { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of { avgMs, timestamp }
avgMs: number
timestamp: string
tracerouteResultsByColo: optional array of { colo, roundTripTime }
colo: string

Cloudflare colo

roundTripTime: { history, avgMs, overTime }
history: array of { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of { avgMs, timestamp }
avgMs: number
timestamp: string

TestsUnique Devices

Get count of devices targeted
GET/accounts/{account_id}/dex/tests/unique-devices
ModelsExpand Collapse
UniqueDevices { uniqueDevicesTotal }
uniqueDevicesTotal: number

total number of unique devices