Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform DEX Synthetic Application Monitoring API

The DEX Synthetic Application Monitoring API from APIs.io Engineering Platform — 12 operation(s) for dex synthetic application monitoring.

This API exposes 12 operations across 12 paths, and defines 42 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

12 operations 12 paths 42 schemas 12 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform DEX Synthetic Application Monitoring API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.

DEX Synthetic Application Monitoring 12
GET
/accounts/{account_id}/dex/colos
APIs.io Engineering Platform List Cloudflare colos
dex-endpoints-list-colos 4 params → 4XX200
GET
/accounts/{account_id}/dex/fleet-status/devices
APIs.io Engineering Platform List fleet status devices
dex-fleet-status-devices 13 params → 4XX200
GET
/accounts/{account_id}/dex/fleet-status/live
APIs.io Engineering Platform List fleet status details by dimension
dex-fleet-status-live 2 params → 4XX200
GET
/accounts/{account_id}/dex/fleet-status/over-time
APIs.io Engineering Platform List fleet status aggregate details by dimension
dex-fleet-status-over-time 5 params → 4XX200
GET
/accounts/{account_id}/dex/http-tests/{test_id}
APIs.io Engineering Platform Get details and aggregate metrics for an http test
dex-endpoints-http-test-details 7 params → 4XX200
GET
/accounts/{account_id}/dex/http-tests/{test_id}/percentiles
APIs.io Engineering Platform Get percentiles for an http test
dex-endpoints-http-test-percentiles 6 params → 4XX200
GET
/accounts/{account_id}/dex/tests/overview
APIs.io Engineering Platform List DEX test analytics
dex-endpoints-list-tests-overview 6 params → 4XX200
GET
/accounts/{account_id}/dex/tests/unique-devices
APIs.io Engineering Platform Get count of devices targeted
dex-endpoints-tests-unique-devices 3 params → 4XX200
GET
/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path
APIs.io Engineering Platform Get details for a specific traceroute test run
dex-endpoints-traceroute-test-result-network-path 2 params → 4XX200
GET
/accounts/{account_id}/dex/traceroute-tests/{test_id}
APIs.io Engineering Platform Get details and aggregate metrics for a traceroute test
dex-endpoints-traceroute-test-details 7 params → 4XX200
GET
/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path
APIs.io Engineering Platform Get network path breakdown for a traceroute test
dex-endpoints-traceroute-test-network-path 6 params → 4XX200
GET
/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles
APIs.io Engineering Platform Get percentiles for a traceroute test
dex-endpoints-traceroute-test-percentiles 6 params → 4XX200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are digital-experience-monitoring_http_details_response (9 properties), digital-experience-monitoring_traceroute_details_response (8 properties), digital-experience-monitoring_device (7 properties), digital-experience-monitoring_traceroute_test_network_path_response (7 properties). Each schema is shown below with its type and property counts.

digital-experience-monitoring_test_stat_over_time
object
4 properties 1 required
digital-experience-monitoring_api-response-single
object
digital-experience-monitoring_device_id
string
Device-specific ID, given as UUID v4
digital-experience-monitoring_percentiles
object
4 properties
digital-experience-monitoring_mode
string
The mode under which the WARP client is run
digital-experience-monitoring_traceroute_details_percentiles_response
object
3 properties
digital-experience-monitoring_test_stat_pct_over_time
object
4 properties 1 required
digital-experience-monitoring_api-response-common-failure
object
4 properties 4 required
digital-experience-monitoring_timing_aggregates
object
3 properties 1 required
digital-experience-monitoring_device
object
7 properties 7 required
digital-experience-monitoring_messages
array
digital-experience-monitoring_api-response-collection
object
digital-experience-monitoring_http_details_response
object
9 properties
digital-experience-monitoring_result_info
object
4 properties
digital-experience-monitoring_traceroute_test_network_path_response
object
7 properties 1 required
digital-experience-monitoring_timestamp
string
Timestamp in ISO format
digital-experience-monitoring_status
string
Network status
digital-experience-monitoring_source
string
Specifies fleet status details source
digital-experience-monitoring_unique_devices_response
object
1 property 1 required
digital-experience-monitoring_account_identifier
string
digital-experience-monitoring_colo
string
Cloudflare colo
digital-experience-monitoring_http_details_percentiles_response
object
3 properties
digital-experience-monitoring_uniqueDevicesTotal
number
Number of unique devices
digital-experience-monitoring_page
number
Page number of paginated results
digital-experience-monitoring_live_stat
object
2 properties
digital-experience-monitoring_traceroute_details_response
object
8 properties 4 required
digital-experience-monitoring_uuid
string
API Resource UUID tag.
digital-experience-monitoring_since_minutes
number
Number of minutes before current time
digital-experience-monitoring_aggregate_stat
object
3 properties 1 required
digital-experience-monitoring_fleet_status_live_response
digital-experience-monitoring_aggregate_time_slot
object
2 properties 2 required
digital-experience-monitoring_aggregate_time_period
object
2 properties 2 required
digital-experience-monitoring_api-response-common
object
3 properties 3 required
digital-experience-monitoring_fleet_status_devices_response
digital-experience-monitoring_personEmail
string
User contact email address
digital-experience-monitoring_colos_response
array
array of colos.
3 properties
digital-experience-monitoring_version
string
WARP client version
digital-experience-monitoring_per_page
number
Number of items per page
digital-experience-monitoring_traceroute_test_result_network_path_response
object
5 properties 2 required
digital-experience-monitoring_sort_by
string
Dimension to sort results by
digital-experience-monitoring_tests_response
object
2 properties 2 required
digital-experience-monitoring_platform
string
Operating system

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-dex-synthetic-application-monitoring-api-openapi.yml Raw ↑