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

Tests

List DEX test analytics
client.ZeroTrust.DEX.Tests.List(ctx, params) (*V4PagePagination[Tests], error)
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
type AggregateTimePeriod struct{…}
Units AggregateTimePeriodUnits
One of the following:
const AggregateTimePeriodUnitsHours AggregateTimePeriodUnits = "hours"
const AggregateTimePeriodUnitsDays AggregateTimePeriodUnits = "days"
const AggregateTimePeriodUnitsTestRuns AggregateTimePeriodUnits = "testRuns"
Value int64
type Tests struct{…}
OverviewMetrics TestsOverviewMetrics
TestsTotal int64

number of tests.

AvgHTTPAvailabilityPct float64optional

percentage availability for all HTTP test results in response

formatfloat
AvgTracerouteAvailabilityPct float64optional

percentage availability for all traceroutes results in response

formatfloat
Tests []TestsTest

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 bool

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 TestsTestsKind

test type, http or traceroute

One of the following:
const TestsTestsKindHTTP TestsTestsKind = "http"
const TestsTestsKindTraceroute TestsTestsKind = "traceroute"
Name string

name given to this test

Updated string
HTTPResults TestsTestsHTTPResultsoptional
ResourceFetchTime TestsTestsHTTPResultsResourceFetchTime
History []TestsTestsHTTPResultsResourceFetchTimeHistory
AvgMs int64optional
DeltaPct float64optional
formatfloat
AvgMs int64optional
OverTime TestsTestsHTTPResultsResourceFetchTimeOverTimeoptional
Values []TestsTestsHTTPResultsResourceFetchTimeOverTimeValue
AvgMs int64
Timestamp string
HTTPResultsByColo []TestsTestsHTTPResultsByColooptional
Colo string

Cloudflare colo

ResourceFetchTime TestsTestsHTTPResultsByColoResourceFetchTime
History []TestsTestsHTTPResultsByColoResourceFetchTimeHistory
AvgMs int64optional
DeltaPct float64optional
formatfloat
AvgMs int64optional
OverTime TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeoptional
Values []TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue
AvgMs int64
Timestamp string
Method stringoptional

for HTTP, the method to use when running the test

TargetPolicies []DigitalExperienceMonitoroptional
ID string

API Resource UUID tag.

maxLength36
Default bool

Whether the policy is the default for the account

Name string
Targeted booloptional
TracerouteResults TestsTestsTracerouteResultsoptional
RoundTripTime TestsTestsTracerouteResultsRoundTripTime
History []TestsTestsTracerouteResultsRoundTripTimeHistory
AvgMs int64optional
DeltaPct float64optional
formatfloat
AvgMs int64optional
OverTime TestsTestsTracerouteResultsRoundTripTimeOverTimeoptional
Values []TestsTestsTracerouteResultsRoundTripTimeOverTimeValue
AvgMs int64
Timestamp string
TracerouteResultsByColo []TestsTestsTracerouteResultsByColooptional
Colo string

Cloudflare colo

RoundTripTime TestsTestsTracerouteResultsByColoRoundTripTime
History []TestsTestsTracerouteResultsByColoRoundTripTimeHistory
AvgMs int64optional
DeltaPct float64optional
formatfloat
AvgMs int64optional
OverTime TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeoptional
Values []TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue
AvgMs int64
Timestamp string

TestsUnique Devices

Get count of devices targeted
client.ZeroTrust.DEX.Tests.UniqueDevices.List(ctx, params) (*UniqueDevices, error)
GET/accounts/{account_id}/dex/tests/unique-devices
ModelsExpand Collapse
type UniqueDevices struct{…}
UniqueDevicesTotal int64

total number of unique devices