--- title: List DEX test analytics --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zero Trust](https://developers.cloudflare.com/api/python/resources/zero_trust) [DEX](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex) [Tests](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/tests) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List DEX test analytics zero\_trust.dex.tests.list(TestListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[Tests]] GET/accounts/{account\_id}/dex/tests/overview List DEX tests with overview metrics. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

User Service Key

Used when interacting with the Origin CA certificates API. View/change your key. **Example:**

X-Auth-User-Service-Key: v1.0-144c9defac04969c7bfad8ef-631a41d003a32d25fe878081ef365c49503f7fada600da935e2851a1c7326084b85cbf6429c4b859de8475731dc92a9c329631e6d59e6c73da7b198497172b4cefe071d90d0f5d2719

##### Accepted Permissions (at least one required) `Cloudflare DEX Write``Cloudflare DEX Read``Zero Trust Report``Zero Trust Read` ##### ParametersExpand Collapse account\_id: str Unique identifier linked to an account. maxLength32 [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) colo: Optional\[str] Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20colo%20%3E%20(schema)>) device\_id: Optional\[Sequence\[str]] Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20deviceId%20%3E%20(schema)>)

kind: Optional\[Literal\["http", "traceroute"]] Filter by test type.

One of the following: "http" Link to this property "traceroute" Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20kind%20%3E%20(schema)>) page: Optional\[float] Page number of paginated results minimum1 [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: Optional\[float] Number of items per page maximum50 minimum1 [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) registration\_id: Optional\[str] Optionally filter results to a specific device registration. Must be used in combination with a single deviceId. [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20registration_id%20%3E%20(schema)>) test\_name: Optional\[str] Optionally filter results by test name. [Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20testName%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class Tests: …

overview\_metrics: OverviewMetrics

tests\_total: int number of tests. Link to this property avg\_http\_availability\_pct: Optional\[float] percentage availability for all HTTP test results in response. formatfloat Link to this property avg\_traceroute\_availability\_pct: Optional\[float] percentage availability for all traceroutes results in response. formatfloat Link to this property

Link to this property

tests: List\[Test] array of test results objects.

id: str API Resource UUID tag. maxLength36 Link to this property created: str date the test was created. Link to this property description: str the test description defined during configuration Link to this property enabled: bool if true, then the test will run on targeted devices. Else, the test will not run. Link to this property host: str Link to this property interval: str The interval at which the synthetic application test is set to run. Link to this property

kind: Literal\["http", "traceroute"] test type, http or traceroute

One of the following: "http" Link to this property "traceroute" Link to this property

Link to this property name: str name given to this test Link to this property updated: str Link to this property

http\_results: Optional\[TestHTTPResults]

resource\_fetch\_time: TestHTTPResultsResourceFetchTime

history: List\[TestHTTPResultsResourceFetchTimeHistory]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property

over\_time: Optional\[TestHTTPResultsResourceFetchTimeOverTime]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property

values: List\[TestHTTPResultsResourceFetchTimeOverTimeValue]

avg\_ms: int Link to this property timestamp: str Link to this property

Link to this property

http\_results\_by\_colo: Optional\[List\[TestHTTPResultsByColo]]

colo: str Cloudflare colo Link to this property

resource\_fetch\_time: TestHTTPResultsByColoResourceFetchTime

history: List\[TestHTTPResultsByColoResourceFetchTimeHistory]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property

over\_time: Optional\[TestHTTPResultsByColoResourceFetchTimeOverTime]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property

values: List\[TestHTTPResultsByColoResourceFetchTimeOverTimeValue]

avg\_ms: int Link to this property timestamp: str Link to this property

Link to this property

Link to this property method: Optional\[str] for HTTP, the method to use when running the test Link to this property

target\_policies: Optional\[List\[DigitalExperienceMonitor]]

id: str API Resource UUID tag. maxLength36 Link to this property default: bool Whether the policy is the default for the account. Link to this property name: str Link to this property

Link to this property targeted: Optional\[bool] Link to this property

traceroute\_results: Optional\[TestTracerouteResults]

round\_trip\_time: TestTracerouteResultsRoundTripTime

history: List\[TestTracerouteResultsRoundTripTimeHistory]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property

over\_time: Optional\[TestTracerouteResultsRoundTripTimeOverTime]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property

values: List\[TestTracerouteResultsRoundTripTimeOverTimeValue]

avg\_ms: int Link to this property timestamp: str Link to this property

Link to this property

traceroute\_results\_by\_colo: Optional\[List\[TestTracerouteResultsByColo]]

colo: str Cloudflare colo Link to this property

round\_trip\_time: TestTracerouteResultsByColoRoundTripTime

history: List\[TestTracerouteResultsByColoRoundTripTimeHistory]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property

Link to this property avg\_ms: Optional\[int] Link to this property

over\_time: Optional\[TestTracerouteResultsByColoRoundTripTimeOverTime]

time\_period: AggregateTimePeriod

units: Literal\["hours", "days", "testRuns"]

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: int Link to this property

Link to this property

values: List\[TestTracerouteResultsByColoRoundTripTimeOverTimeValue]

avg\_ms: int Link to this property timestamp: str Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(model)%20tests%20%3E%20(schema)>) ### List DEX test analytics Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.zero_trust.dex.tests.list( account_id="01a7362d577a6c3019a474fd6f485823", ) page = page.result.items[0] print(page.overview_metrics) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "overviewMetrics": { "testsTotal": 0, "avgHttpAvailabilityPct": 0, "avgTracerouteAvailabilityPct": 0 }, "tests": [ { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "created": "created", "description": "description", "enabled": true, "host": "host", "interval": "interval", "kind": "http", "name": "name", "updated": "updated", "httpResults": { "resourceFetchTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } }, "httpResultsByColo": [ { "colo": "SJC", "resourceFetchTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } } ], "method": "method", "target_policies": [ { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "default": true, "name": "name" } ], "targeted": true, "tracerouteResults": { "roundTripTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } }, "tracerouteResultsByColo": [ { "colo": "SJC", "roundTripTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } } ] } ] } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "overviewMetrics": { "testsTotal": 0, "avgHttpAvailabilityPct": 0, "avgTracerouteAvailabilityPct": 0 }, "tests": [ { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "created": "created", "description": "description", "enabled": true, "host": "host", "interval": "interval", "kind": "http", "name": "name", "updated": "updated", "httpResults": { "resourceFetchTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } }, "httpResultsByColo": [ { "colo": "SJC", "resourceFetchTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } } ], "method": "method", "target_policies": [ { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "default": true, "name": "name" } ], "targeted": true, "tracerouteResults": { "roundTripTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } }, "tracerouteResultsByColo": [ { "colo": "SJC", "roundTripTime": { "history": [ { "timePeriod": { "units": "hours", "value": 0 }, "avgMs": 0, "deltaPct": 0 } ], "avgMs": 0, "overTime": { "timePeriod": { "units": "hours", "value": 0 }, "values": [ { "avgMs": 0, "timestamp": "timestamp" } ] } } } ] } ] } } ```