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

Tests

List DEX test analytics
zero_trust.dex.tests.list(TestListParams**kwargs) -> SyncV4PagePagination[Optional[Tests]]
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
class AggregateTimePeriod: …
units: Literal["hours", "days", "testRuns"]
One of the following:
"hours"
"days"
"testRuns"
value: int
class Tests: …
overview_metrics: OverviewMetrics
tests_total: int

number of tests.

avg_http_availability_pct: Optional[float]

percentage availability for all HTTP test results in response

formatfloat
avg_traceroute_availability_pct: Optional[float]

percentage availability for all traceroutes results in response

formatfloat
tests: List[Test]

array of test results objects.

id: str

API Resource UUID tag.

maxLength36
created: str

date the test was created.

description: str

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: str
interval: str

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

kind: Literal["http", "traceroute"]

test type, http or traceroute

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

name given to this test

updated: str
http_results: Optional[TestHTTPResults]
resource_fetch_time: TestHTTPResultsResourceFetchTime
history: List[TestHTTPResultsResourceFetchTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestHTTPResultsResourceFetchTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestHTTPResultsResourceFetchTimeOverTimeValue]
avg_ms: int
timestamp: str
http_results_by_colo: Optional[List[TestHTTPResultsByColo]]
colo: str

Cloudflare colo

resource_fetch_time: TestHTTPResultsByColoResourceFetchTime
history: List[TestHTTPResultsByColoResourceFetchTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestHTTPResultsByColoResourceFetchTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestHTTPResultsByColoResourceFetchTimeOverTimeValue]
avg_ms: int
timestamp: str
method: Optional[str]

for HTTP, the method to use when running the test

target_policies: Optional[List[DigitalExperienceMonitor]]
id: str

API Resource UUID tag.

maxLength36
default: bool

Whether the policy is the default for the account

name: str
targeted: Optional[bool]
traceroute_results: Optional[TestTracerouteResults]
round_trip_time: TestTracerouteResultsRoundTripTime
history: List[TestTracerouteResultsRoundTripTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestTracerouteResultsRoundTripTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestTracerouteResultsRoundTripTimeOverTimeValue]
avg_ms: int
timestamp: str
traceroute_results_by_colo: Optional[List[TestTracerouteResultsByColo]]
colo: str

Cloudflare colo

round_trip_time: TestTracerouteResultsByColoRoundTripTime
history: List[TestTracerouteResultsByColoRoundTripTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestTracerouteResultsByColoRoundTripTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestTracerouteResultsByColoRoundTripTimeOverTimeValue]
avg_ms: int
timestamp: str

TestsUnique Devices

Get count of devices targeted
zero_trust.dex.tests.unique_devices.list(UniqueDeviceListParams**kwargs) -> UniqueDevices
GET/accounts/{account_id}/dex/tests/unique-devices
ModelsExpand Collapse
class UniqueDevices: …
unique_devices_total: int

total number of unique devices