{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 DEX Synthetic Application Monitoring API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "DEX Synthetic Application Monitoring", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform List Cloudflare colos", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/colos", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "from", "value": "", "type": "query", "description": "Start time for connection period in RFC3339 (ISO 8601) format." }, { "name": "to", "value": "", "type": "query", "description": "End time for connection period in RFC3339 (ISO 8601) format." }, { "name": "sortBy", "value": "", "type": "query", "description": "Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically." } ] }, "docs": "List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically." }, { "info": { "name": "APIs.io Engineering Platform List fleet status devices", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/fleet-status/devices", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Unique identifier for account" }, { "name": "to", "value": "", "type": "query", "description": "Time range end in ISO format" }, { "name": "from", "value": "", "type": "query", "description": "Time range beginning in ISO format" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "sort_by", "value": "", "type": "query", "description": "Dimension to sort results by" }, { "name": "colo", "value": "", "type": "query", "description": "Cloudflare colo" }, { "name": "device_id", "value": "", "type": "query", "description": "Device-specific ID, given as UUID v4" }, { "name": "mode", "value": "", "type": "query", "description": "The mode under which the WARP client is run" }, { "name": "status", "value": "", "type": "query", "description": "Network status" }, { "name": "platform", "value": "", "type": "query", "description": "Operating system" }, { "name": "version", "value": "", "type": "query", "description": "WARP client version" }, { "name": "source", "value": "", "type": "query", "description": "Source:\n * `hourly` - device details aggregated hourly, up to 7 days prior\n * `last_seen` - device details, up to 24 hours prior\n * `raw` - device details, up to 7 days prior\n" } ] }, "docs": "List details for devices using WARP" }, { "info": { "name": "APIs.io Engineering Platform List fleet status details by dimension", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/fleet-status/live", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Unique identifier for account" }, { "name": "since_minutes", "value": "", "type": "query", "description": "Number of minutes before current time" } ] }, "docs": "List details for live (up to 60 minutes) devices using WARP" }, { "info": { "name": "APIs.io Engineering Platform List fleet status aggregate details by dimension", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/fleet-status/over-time", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Unique identifier for account" }, { "name": "to", "value": "", "type": "query", "description": "Time range end in ISO format" }, { "name": "from", "value": "", "type": "query", "description": "Time range beginning in ISO format" }, { "name": "colo", "value": "", "type": "query", "description": "Cloudflare colo" }, { "name": "device_id", "value": "", "type": "query", "description": "Device-specific ID, given as UUID v4" } ] }, "docs": "List details for devices using WARP, up to 7 days" }, { "info": { "name": "APIs.io Engineering Platform Get details and aggregate metrics for an http test", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/http-tests/:test_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "from", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "to", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days." }, { "info": { "name": "APIs.io Engineering Platform Get percentiles for an http test", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/http-tests/:test_id/percentiles", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "from", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO format" }, { "name": "to", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO format" }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get percentiles for an http test for a given time period between 1 hour and 7 days." }, { "info": { "name": "APIs.io Engineering Platform List DEX test analytics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/tests/overview", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." }, { "name": "testName", "value": "", "type": "query", "description": "Optionally filter results by test name" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List DEX tests with overview metrics" }, { "info": { "name": "APIs.io Engineering Platform Get count of devices targeted", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/tests/unique-devices", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "testName", "value": "", "type": "query", "description": "Optionally filter results by test name" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." } ] }, "docs": "Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days." }, { "info": { "name": "APIs.io Engineering Platform Get details for a specific traceroute test run", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/traceroute-test-results/:test_result_id/network-path", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account" }, { "name": "test_result_id", "value": "", "type": "path", "description": "unique identifier for a specific traceroute test" } ] }, "docs": "Get a breakdown of hops and performance metrics for a specific traceroute test run" }, { "info": { "name": "APIs.io Engineering Platform Get details and aggregate metrics for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/traceroute-tests/:test_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Unique identifier linked to an account" }, { "name": "test_id", "value": "", "type": "path", "description": "Unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "from", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "to", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days." }, { "info": { "name": "APIs.io Engineering Platform Get network path breakdown for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/traceroute-tests/:test_id/network-path", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account" }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Device to filter tracroute result runs to" }, { "name": "from", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "to", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." } ] }, "docs": "Get a breakdown of metrics by hop for individual traceroute test runs" }, { "info": { "name": "APIs.io Engineering Platform Get percentiles for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/dex/traceroute-tests/:test_id/percentiles", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "from", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO format" }, { "name": "to", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO format" }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get percentiles for a traceroute test for a given time period between 1 hour and 7 days." } ] } ], "bundled": true }