APIs.io Engineering Platform · Schema
digital-experience-monitoring_tests_response
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| overviewMetrics | object | |
| tests | array | array of test results objects. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/digital-experience-monitoring_tests_response",
"title": "digital-experience-monitoring_tests_response",
"properties": {
"overviewMetrics": {
"properties": {
"avgHttpAvailabilityPct": {
"description": "percentage availability for all HTTP test results in response",
"format": "float",
"nullable": true,
"type": "number"
},
"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": {
"$ref": "#/components/schemas/digital-experience-monitoring_timing_aggregates"
}
},
"required": [
"resourceFetchTime"
],
"type": "object"
},
"httpResultsByColo": {
"items": {
"properties": {
"colo": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
},
"resourceFetchTime": {
"$ref": "#/components/schemas/digital-experience-monitoring_timing_aggregates"
}
},
"required": [
"colo",
"resourceFetchTime"
],
"type": "object"
},
"type": "array"
},
"id": {
"$ref": "#/components/schemas/digital-experience-monitoring_uuid"
},
"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"
},
"target_policies": {
"items": {
"properties": {
"default": {
"description": "Whether the policy is the default for the account",
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"default"
],
"type": "object"
},
"nullable": true,
"type": "array"
},
"targeted": {
"type": "boolean"
},
"tracerouteResults": {
"nullable": true,
"properties": {
"roundTripTime": {
"$ref": "#/components/schemas/digital-experience-monitoring_timing_aggregates"
}
},
"required": [
"roundTripTime"
],
"type": "object"
},
"tracerouteResultsByColo": {
"items": {
"properties": {
"colo": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
},
"roundTripTime": {
"$ref": "#/components/schemas/digital-experience-monitoring_timing_aggregates"
}
},
"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"
}