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

HTTP Tests

Get details and aggregate metrics for an http test
client.zeroTrust.dex.httpTests.get(stringtestId, HTTPTestGetParams { account_id, from, interval, 3 more } params, RequestOptionsoptions?): HTTPDetails { host, httpStats, httpStatsByColo, 6 more }
GET/accounts/{account_id}/dex/http-tests/{test_id}
ModelsExpand Collapse
HTTPDetails { host, httpStats, httpStatsByColo, 6 more }
host?: string

The url of the HTTP synthetic application test

httpStats?: HTTPStats | null
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period

formatfloat
max?: number | null

highest observed in the time period

formatfloat
min?: number | null

lowest observed in the time period

formatfloat
dnsResponseTimeMs: TestStatOverTime { slots, avg, max, min }
httpStatusCode: Array<HTTPStatusCode>
status200: number
status300: number
status400: number
status500: number
timestamp: string
resourceFetchTimeMs: TestStatOverTime { slots, avg, max, min }
serverResponseTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period

httpStatsByColo?: Array<HTTPStatsByColo>
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period

formatfloat
max?: number | null

highest observed in the time period

formatfloat
min?: number | null

lowest observed in the time period

formatfloat
colo: string
dnsResponseTimeMs: TestStatOverTime { slots, avg, max, min }
httpStatusCode: Array<HTTPStatusCode>
status200: number
status300: number
status400: number
status500: number
timestamp: string
resourceFetchTimeMs: TestStatOverTime { slots, avg, max, min }
serverResponseTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period

interval?: string

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

kind?: "http"
method?: string

The HTTP method to use when running the test

name?: string

The name of the HTTP synthetic application test

target_policies?: Array<DigitalExperienceMonitor { id, default, name } > | null
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account

name: string
targeted?: boolean

HTTP TestsPercentiles

Get percentiles for an http test
client.zeroTrust.dex.httpTests.percentiles.get(stringtestId, PercentileGetParams { account_id, from, to, 2 more } params, RequestOptionsoptions?): HTTPDetailsPercentiles { dnsResponseTimeMs, resourceFetchTimeMs, serverResponseTimeMs }
GET/accounts/{account_id}/dex/http-tests/{test_id}/percentiles
ModelsExpand Collapse
HTTPDetailsPercentiles { dnsResponseTimeMs, resourceFetchTimeMs, serverResponseTimeMs }
dnsResponseTimeMs?: Percentiles { p50, p90, p95, p99 }
resourceFetchTimeMs?: Percentiles { p50, p90, p95, p99 }
serverResponseTimeMs?: Percentiles { p50, p90, p95, p99 }
TestStatOverTime { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
avg?: number | null

average observed in the time period

max?: number | null

highest observed in the time period

min?: number | null

lowest observed in the time period