Network Health Endpoint

Summary

The Network Health endpoint is designed to retrieve aggregated data for Network Health Checks.

Traceroute Endpoint URL
Basic Example
Required Parameters
Optional Parameters
Data Filtering
Group By Options
Data Column Options

Traceroute Endpoint URL

All requests to this endpoint should be HTTP POST with "application/json" as the Content-Type.

https://api.bluetriangletech.com/network-health

Basic Example

This example retrieves all of the available dataColumns for each page name over a 24 hour period.

{
  "site": "demo",
  "start": 1624377600,
  "end": 1624420740,
  "dataColumns": [
    "latency_avg",
    "latency_geo",
    "latency_min",
    "latency_max",
    "latency_stdev",
    "latency_last",
    "packets_sent",
    "packets_received",
    "packet_size",
    "jitter",
    "jitter_avg",
    "jitter_max",
    "jitter_interarrival",
    "hops",
    "packet_loss",
    "failures",
    "pageHits"
  ],
  "group": [
    "pageName"
  ]
}

Required Parameters

Key	Type	Description	Value/Constraints
site	string	Site the data is being pulled from. Uses the unique ID associated with your tag.	None
start	integer	Start time of the data in epoch time.	epoch (seconds)
end	integer	End time of the data in epoch time.	epoch (seconds)
group	array	Group the data. If grouping by time, bucketSize and bucketValue will be available.	Limited to 3 columns. Available "group by" parameters
dataColumns	array	Performance data columns to be retrieved. All timings are returned in milliseconds.	Data Column options

Optional Parameters

Key	Type	Description	Value/Constraints
bucketSize	enum	Whether to group the data by minute, hour, or day. Only available if grouping by ‘time’. Minute bucket is available for time periods less than 6 hours. Hour bucket is available for less than 14 days. Day bucket is available for greater than 2 days	default = "auto" options: "auto", "minute", "hour", "day"
bucketValue	integer	Determines the size of the bucket size. For example, if bucketSize is set to minute and bucketValue is set to 15, the data will return in 15 minute increments	default = 1
avgType	enum	The statistical method used for calculations	default = "arithmetic" options: "arithmetic", "geometric", "percentile", "standardDeviation"
percentile	integer	The value used to determine the percentile distribution. Only available when using the avgType of percentile
order	string array	Orders the data by column. If used as an array, the sort parameter must be in the same order as the order. For example: "order":["device", "pageHits"], "sort":["asc","desc"] In this example, device will be in ascending order and pageHits will be in descending order.
sort	string array	Indicates whether the data is sorted by ascending or descending
limit	integer	Limits the number of rows returned	default: 10000, max: 50000

Data Filtering

Key	Type	Description	Value/Constraints
trafficSegment	array	Traffic Segment
pageName	array	Page Name
pageGroup	array	Page Group
agentLocation	array	Agent Location
excluded	array	Delineates data with a numbering system	(0 = standard data, 11 = instant measurement)
measurementID	array	Unique ID for that run of the measurement

Group By Options

Group Options	Description
trafficSegment	Traffic Segment
pageName	Page Name
pageGroup	Page Group
agentLocation	Agent Location
country	Country
isp	Internet Service Provider (ISP)
error_code	Error Code
hostName	Host Name
time	Time
excluded	Excluded value - delineates data with a numbering system

Data Column Options

Data Column Name	Description
time	Time
latency_avg	Latency (arithmetic mean)
latency_geo	Latency (geometric mean)
latency_min	Minimum latency
latency_max	Maximum latency
latency_last	Latency of the last hop
latency_stdev	Latency (standard deviation)
packets_sent	Total Packets sent
packets_recieved	Total Packets received
jitter	Jitter
jitter_avg	Average Jitter
jitter_max	Maximum Jitter
jitter_interarrival	Interarrival Jitter
hops	Number of hops for the traceroute measurement
packet_loss	Percentage of packet loss
packet_size	Size (bytes) of the packet
failures	The number of measurements/tests that failed.
pageHits	The number of measurements/tests.

Articles in this section

Summary

Contents

Traceroute Endpoint URL

Basic Example

Required Parameters

Optional Parameters

Data Filtering

Group By Options

Data Column Options

Comments

Articles in this section

Summary

Contents

Traceroute Endpoint URL

Basic Example

Required Parameters

Optional Parameters

Data Filtering

Group By Options

Data Column Options

Related articles