List DEX tests
/accounts/{account_identifier}/dex/tests
get
DEX Synthetic Application Montitoring
dex-endpoints-list-tests
null{
"enum": [
"#dex:read",
"#teams:report"
]
}[
{
"description": "unique identifier linked to an account in the API request path.",
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"example": "01a7362d577a6c3019a474fd6f485823",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.",
"in": "query",
"name": "colo",
"schema": {
"type": "string"
}
},
{
"description": "Optionally filter results by test name",
"in": "query",
"name": "testName",
"schema": {
"type": "string"
}
},
{
"description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.",
"in": "query",
"name": "deviceId",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"description": "Page number of paginated results",
"in": "query",
"name": "page",
"schema": {
"default": 1,
"minimum": 1,
"type": "number"
}
},
{
"description": "Number of items per page",
"in": "query",
"name": "per_page",
"schema": {
"default": 10,
"maximum": 50,
"minimum": 1,
"type": "number"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"overviewMetrics": {
"properties": {
"avgTracerouteAvailabilityPct": {
"description": "percentage availability for all traceroutes results in response",
"format": "float",
"nullable": true,
"type": "number"
},
"testsTotal": {
"description": "number of tests.",
"type": "integer"
}
},
"required": [
"testsTotal"
],
"type": "object"
},
"tests": {
"description": "array of test results objects.",
"items": {
"properties": {
"created": {
"description": "date the test was created.",
"type": "string"
},
"description": {
"description": "the test description defined during configuration",
"type": "string"
},
"enabled": {
"description": "if true, then the test will run on targeted devices. Else, the test will not run.",
"type": "boolean"
},
"host": {
"type": "string"
},
"httpResults": {
"nullable": true,
"properties": {
"resourceFetchTime": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"history": {
"items": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"deltaPct": {
"format": "float",
"nullable": true,
"type": "number"
},
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
}
},
"required": [
"timePeriod"
],
"type": "object"
},
"type": "array"
},
"overTime": {
"nullable": true,
"properties": {
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
},
"values": {
"items": {
"properties": {
"avgMs": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
},
"required": [
"timestamp",
"avgMs"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"values",
"timePeriod"
],
"type": "object"
}
},
"required": [
"history"
],
"type": "object"
}
},
"required": [
"resourceFetchTime"
],
"type": "object"
},
"httpResultsByColo": {
"items": {
"properties": {
"colo": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
},
"resourceFetchTime": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"history": {
"items": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"deltaPct": {
"format": "float",
"nullable": true,
"type": "number"
},
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
}
},
"required": [
"timePeriod"
],
"type": "object"
},
"type": "array"
},
"overTime": {
"nullable": true,
"properties": {
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
},
"values": {
"items": {
"properties": {
"avgMs": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
},
"required": [
"timestamp",
"avgMs"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"values",
"timePeriod"
],
"type": "object"
}
},
"required": [
"history"
],
"type": "object"
}
},
"required": [
"colo",
"resourceFetchTime"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "API Resource UUID tag.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"interval": {
"description": "The interval at which the synthetic application test is set to run.",
"type": "string"
},
"kind": {
"description": "test type, http or traceroute",
"enum": [
"http",
"traceroute"
],
"type": "string"
},
"method": {
"description": "for HTTP, the method to use when running the test",
"type": "string"
},
"name": {
"description": "name given to this test",
"type": "string"
},
"tracerouteResults": {
"nullable": true,
"properties": {
"roundTripTime": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"history": {
"items": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"deltaPct": {
"format": "float",
"nullable": true,
"type": "number"
},
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
}
},
"required": [
"timePeriod"
],
"type": "object"
},
"type": "array"
},
"overTime": {
"nullable": true,
"properties": {
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
},
"values": {
"items": {
"properties": {
"avgMs": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
},
"required": [
"timestamp",
"avgMs"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"values",
"timePeriod"
],
"type": "object"
}
},
"required": [
"history"
],
"type": "object"
}
},
"required": [
"roundTripTime"
],
"type": "object"
},
"tracerouteResultsByColo": {
"items": {
"properties": {
"colo": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
},
"roundTripTime": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"history": {
"items": {
"properties": {
"avgMs": {
"nullable": true,
"type": "integer"
},
"deltaPct": {
"format": "float",
"nullable": true,
"type": "number"
},
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
}
},
"required": [
"timePeriod"
],
"type": "object"
},
"type": "array"
},
"overTime": {
"nullable": true,
"properties": {
"timePeriod": {
"properties": {
"units": {
"enum": [
"hours",
"days",
"testRuns"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value",
"units"
],
"type": "object"
},
"values": {
"items": {
"properties": {
"avgMs": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
},
"required": [
"timestamp",
"avgMs"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"values",
"timePeriod"
],
"type": "object"
}
},
"required": [
"history"
],
"type": "object"
}
},
"required": [
"colo",
"roundTripTime"
],
"type": "object"
},
"type": "array"
},
"updated": {
"type": "string"
}
},
"required": [
"id",
"name",
"kind",
"interval",
"enabled",
"description",
"updated",
"created",
"host"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"overviewMetrics",
"tests"
],
"type": "object"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "DEX tests list response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "List DEX tests failure response"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]