[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/zero_trust/subresources/dex/subresources/tests [Back]  [Original]
Tests | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Zero Trust
DEX
Copy Markdown

Tests

List DEX test analytics
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
AggregateTimePeriod object { units, value }
units: "hours" or "days" or "testRuns"
One of the following:
"hours"
"days"
"testRuns"
value: number
Tests object { overviewMetrics, tests }
overviewMetrics: object { 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 object { 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 object { resourceFetchTime }
resourceFetchTime: object { history, avgMs, overTime }
history: array of object { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional object { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of object { avgMs, timestamp }
avgMs: number
timestamp: string
httpResultsByColo: optional array of object { colo, resourceFetchTime }
colo: string

Cloudflare colo

resourceFetchTime: object { history, avgMs, overTime }
history: array of object { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional object { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of object { 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 object { roundTripTime }
roundTripTime: object { history, avgMs, overTime }
history: array of object { timePeriod, avgMs, deltaPct }
timePeriod: AggregateTimePeriod { units, value }
avgMs: optional number
deltaPct: optional number
formatfloat
avgMs: optional number
overTime: optional object { timePeriod, values }
timePeriod: AggregateTimePeriod { units, value }
values: array of object { avgMs, timestamp }
avgMs: number
timestamp: string
tracerouteResultsByColo: optional array of object { colo, roundTripTime }
colo: string

Cloudflare colo

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

TestsUnique Devices

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

total number of unique devices

Previous

Percentiles
Next

Unique Devices

On this page

Web Proxy Viewer  |  New URL  |  Original Page