API Reference

Zero Trust

DEX

Traceroute Tests

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get details and aggregate metrics for a traceroute test

client.zeroTrust.dex.tracerouteTests.get(stringtestId, TracerouteTestGetParams { account_id, from, interval, 3 more } params, RequestOptionsoptions?): Traceroute { host, interval, kind, 5 more }

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

Get test details and aggregate performance metrics for a traceroute 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: TracerouteTestGetParams { account_id, from, interval, 3 more }

account_id: string

Path param: Unique identifier linked to an account.

maxLength32

from: string

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

interval: "minute" | "hour"

Query param: Time interval for aggregate time slots.

One of the following:

"minute"

"hour"

to: string

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

colo?: string

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

deviceId?: Array<string>

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

ReturnsExpand Collapse

Traceroute { host, interval, kind, 5 more }

host: string

The host of the Traceroute synthetic application test.

interval: string

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

kind: "traceroute"

name: string

The name of the Traceroute 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

tracerouteStats?: TracerouteStats | 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

hopsCount: 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.

packetLossPct: PacketLossPct { 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

roundTripTimeMs: 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.

uniqueDevicesTotal: number

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

tracerouteStatsByColo?: Array<TracerouteStatsByColo>

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

hopsCount: 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.

packetLossPct: PacketLossPct { 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

roundTripTimeMs: 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.

uniqueDevicesTotal: number

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

Get details and aggregate metrics for a traceroute test

TypeScript

HTTP

TypeScript

Python

Go

Terraform

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const traceroute = await client.zeroTrust.dex.tracerouteTests.get(
  'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
  {
    account_id: '01a7362d577a6c3019a474fd6f485823',
    from: '1689520412000',
    interval: 'minute',
    to: '1689606812000',
  },
);

console.log(traceroute.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": "1.1.1.1",
    "interval": "0h5m0s",
    "kind": "traceroute",
    "name": "Atlassian Sign In Page",
    "target_policies": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "default": true,
        "name": "name"
      }
    ],
    "targeted": true,
    "tracerouteStats": {
      "availabilityPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "hopsCount": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "packetLossPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "roundTripTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "uniqueDevicesTotal": 57
    },
    "tracerouteStatsByColo": [
      {
        "availabilityPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "colo": "DFW",
        "hopsCount": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "packetLossPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "roundTripTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "uniqueDevicesTotal": 57
      }
    ]
  }
}

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": "1.1.1.1",
    "interval": "0h5m0s",
    "kind": "traceroute",
    "name": "Atlassian Sign In Page",
    "target_policies": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "default": true,
        "name": "name"
      }
    ],
    "targeted": true,
    "tracerouteStats": {
      "availabilityPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "hopsCount": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "packetLossPct": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "roundTripTimeMs": {
        "slots": [
          {
            "timestamp": "2023-07-16 15:00:00+00",
            "value": 0
          }
        ],
        "avg": 0,
        "max": 0,
        "min": 0
      },
      "uniqueDevicesTotal": 57
    },
    "tracerouteStatsByColo": [
      {
        "availabilityPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "colo": "DFW",
        "hopsCount": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "packetLossPct": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "roundTripTimeMs": {
          "slots": [
            {
              "timestamp": "2023-07-16 15:00:00+00",
              "value": 0
            }
          ],
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "uniqueDevicesTotal": 57
      }
    ]
  }
}