Summary
The network-health/hits endpoint is designed to retrieve raw data for individual Network Health Checks.
Contents
- Traceroute/hits URL
- Basic Example
- Required Parameters
- Optional Parameters
- Data Filtering
- Data Column Options
Traceroute/hits URL
All requests to this endpoint should be HTTP POST with "application/json" as the Content-Type.
https://api.bluetriangletech.com/network-health/hits
Basic Example
This example pulls all of the results for the demo site over a 24 hour period.
{
"site": "demo",
"start": 1624377600,
"end": 1624420740,
"dataColumns": [
"pageName",
"measurementTime",
"measurementID",
"time",
"region",
"latency_avg",
"latency_geo",
"latency_min",
"latency_max",
"latency_stdev",
"latency_last",
"packets_sent",
"packets_received",
"jitter",
"jitter_avg",
"jitter_max",
"jitter_interarrival",
"hops",
"packet_loss",
"trafficSegment",
"pageName",
"pageGroup",
"agentLocation",
"error_code",
"packet_size",
"output",
"hostname",
"asn",
"excluded",
"configID",
"configName"
],
"order": "time",
"sort": "asc"
}
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) |
dataColumns | array | Performance data columns to be retrieved. All timings are returned in milliseconds. | Data Column options |
Optional Parameters
Key | Type | Description | Value/Constraints |
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 the above 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
|
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 |
Number of packets sent |
packets_recieved |
Number of packets received |
jitter |
Jitter |
jitter_avg |
Average Jitter |
jitter_max |
Maximum Jitter |
jitter_interarrival |
Interarrival Jitter |
hops |
Number of hops |
packet_loss |
Percentage of packet loss |
packet_size |
Size (bytes) of the packet |
trafficSegment |
Traffic Segment |
pageName |
Page Name |
pageGroup |
Page Group |
agentLocation |
Agent Location |
error_code |
0 = success, 1 = failure |
output |
JSON output of the traceroute |
hostname |
hostname of the last hop |
asn |
Autonomous System Number |
excluded |
Excluded number, this delineates scheduled/instant measurements |
time |
Time of the measurement |
configID |
The Network Health Check monitor's ID |
configName |
The Network Health Check monitor's name |