API Reference

Zero Trust

DEX

HTTP Tests

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get details and aggregate metrics for an http test

client.ZeroTrust.DEX.HTTPTests.Get(ctx, testID, params) (*HTTPDetails, error)

GET/accounts/{account_id}/dex/http-tests/{test_id}

Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.

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

Accepted Permissions (at least one required)

Cloudflare DEX WriteCloudflare DEX ReadZero Trust ReportZero Trust Read

ParametersExpand Collapse

testID string

API Resource UUID tag.

maxLength36

params DEXHTTPTestGetParams

AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32

From param.Field[string]

Query param: Start time for aggregate metrics in ISO ms.

Interval param.Field[DexhttpTestGetParamsInterval]

Query param: Time interval for aggregate time slots.

const DexhttpTestGetParamsIntervalMinute DexhttpTestGetParamsInterval = "minute"

const DexhttpTestGetParamsIntervalHour DexhttpTestGetParamsInterval = "hour"

To param.Field[string]

Query param: End time for aggregate metrics in ISO ms.

Colo param.Field[string]Optional

Query param: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.

DeviceID param.Field[[]string]Optional

Query param: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.

ReturnsExpand Collapse

type HTTPDetails struct{…}

Host stringOptional

The url of the HTTP synthetic application test.

HTTPStats HTTPDetailsHTTPStatsOptional

AvailabilityPct HTTPDetailsHTTPStatsAvailabilityPct

Slots []HTTPDetailsHTTPStatsAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64Optional

average observed in the time period.

formatfloat

Max float64Optional

highest observed in the time period.

formatfloat

Min float64Optional

lowest observed in the time period.

formatfloat

DNSResponseTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

HTTPStatusCode []HTTPDetailsHTTPStatsHTTPStatusCode

Status200 int64

Status300 int64

Status400 int64

Status500 int64

Timestamp string

ResourceFetchTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

ServerResponseTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

UniqueDevicesTotal int64

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

HTTPStatsByColo []HTTPDetailsHTTPStatsByColoOptional

AvailabilityPct HTTPDetailsHTTPStatsByColoAvailabilityPct

Slots []HTTPDetailsHTTPStatsByColoAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64Optional

average observed in the time period.

formatfloat

Max float64Optional

highest observed in the time period.

formatfloat

Min float64Optional

lowest observed in the time period.

formatfloat

Colo string

DNSResponseTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

HTTPStatusCode []HTTPDetailsHTTPStatsByColoHTTPStatusCode

Status200 int64

Status300 int64

Status400 int64

Status500 int64

Timestamp string

ResourceFetchTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

ServerResponseTimeMs TestStatOverTime

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64Optional

average observed in the time period.

Max int64Optional

highest observed in the time period.

Min int64Optional

lowest observed in the time period.

UniqueDevicesTotal int64

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

Interval stringOptional

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

Kind HTTPDetailsKindOptional

Method stringOptional

The HTTP method to use when running the test.

Name stringOptional

The name of the HTTP synthetic application 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

Get details and aggregate metrics for an http test

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  httpDetails, err := client.ZeroTrust.DEX.HTTPTests.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    zero_trust.DEXHTTPTestGetParams{
      AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
      From: cloudflare.F("1689520412000"),
      Interval: cloudflare.F(zero_trust.DexhttpTestGetParamsIntervalMinute),
      To: cloudflare.F("1689606812000"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", httpDetails.Host)
}

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": {
    "host": "http://example.com",
    "httpStats": {
      "availabilityPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "dnsResponseTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "httpStatusCode": [
        {
          "status200": 0,
          "status300": 0,
          "status400": 0,
          "status500": 0,
          "timestamp": "2023-07-16 15:00:00+00"
        }
      ],
      "resourceFetchTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "serverResponseTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "uniqueDevicesTotal": 57
    },
    "httpStatsByColo": [
      {
        "availabilityPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "colo": "DFW",
        "dnsResponseTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "httpStatusCode": [
          {
            "status200": 0,
            "status300": 0,
            "status400": 0,
            "status500": 0,
            "timestamp": "2023-07-16 15:00:00+00"
          }
        ],
        "resourceFetchTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "serverResponseTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "uniqueDevicesTotal": 57
      }
    ],
    "interval": "0h5m0s",
    "kind": "http",
    "method": "GET",
    "name": "Atlassian Sign In Page",
    "target_policies": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "default": true,
        "name": "name"
      }
    ],
    "targeted": true
  }
}

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": {
    "host": "http://example.com",
    "httpStats": {
      "availabilityPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "dnsResponseTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "httpStatusCode": [
        {
          "status200": 0,
          "status300": 0,
          "status400": 0,
          "status500": 0,
          "timestamp": "2023-07-16 15:00:00+00"
        }
      ],
      "resourceFetchTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "serverResponseTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "uniqueDevicesTotal": 57
    },
    "httpStatsByColo": [
      {
        "availabilityPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "colo": "DFW",
        "dnsResponseTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "httpStatusCode": [
          {
            "status200": 0,
            "status300": 0,
            "status400": 0,
            "status500": 0,
            "timestamp": "2023-07-16 15:00:00+00"
          }
        ],
        "resourceFetchTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "serverResponseTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "uniqueDevicesTotal": 57
      }
    ],
    "interval": "0h5m0s",
    "kind": "http",
    "method": "GET",
    "name": "Atlassian Sign In Page",
    "target_policies": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "default": true,
        "name": "name"
      }
    ],
    "targeted": true
  }
}