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

Get details and aggregate metrics for a traceroute test

client.ZeroTrust.DEX.TracerouteTests.Get(ctx, testID, params) (*Traceroute, error)
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 DEXTracerouteTestGetParams
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[DEXTracerouteTestGetParamsInterval]

Query param: Time interval for aggregate time slots.

const DEXTracerouteTestGetParamsIntervalMinute DEXTracerouteTestGetParamsInterval = "minute"
const DEXTracerouteTestGetParamsIntervalHour DEXTracerouteTestGetParamsInterval = "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 Traceroute struct{…}
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 TracerouteKind
Name string

The name of the Traceroute 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
TracerouteStats TracerouteTracerouteStatsOptional
AvailabilityPct TracerouteTracerouteStatsAvailabilityPct
Slots []TracerouteTracerouteStatsAvailabilityPctSlot
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
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.

PacketLossPct TracerouteTracerouteStatsPacketLossPct
Slots []TracerouteTracerouteStatsPacketLossPctSlot
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
RoundTripTimeMs 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.

TracerouteStatsByColo []TracerouteTracerouteStatsByColoOptional
AvailabilityPct TracerouteTracerouteStatsByColoAvailabilityPct
Slots []TracerouteTracerouteStatsByColoAvailabilityPctSlot
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
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.

PacketLossPct TracerouteTracerouteStatsByColoPacketLossPct
Slots []TracerouteTracerouteStatsByColoPacketLossPctSlot
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
RoundTripTimeMs 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.

Get details and aggregate metrics for a traceroute test

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"),
  )
  traceroute, err := client.ZeroTrust.DEX.TracerouteTests.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    zero_trust.DEXTracerouteTestGetParams{
      AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
      From: cloudflare.F("1689520412000"),
      Interval: cloudflare.F(zero_trust.DEXTracerouteTestGetParamsIntervalMinute),
      To: cloudflare.F("1689606812000"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", traceroute.Host)
}

{
  "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
{
  "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
      }
    ]
  }
}