HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. timeseriesStats

Retrieve time series jitter statistics for a tunnel

get
http://127.0.0.1:8080/stats/timeseries/jitter

Retrieves historical jitter metrics for a specified tunnel, including average jitter and peak values. Use to monitor network quality and identify latency variability patterns over time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

int64
required
≥ 0

Start of time range as Unix timestamp (seconds since EPOCH). Must be non-negative and less than endTime.

int64
required
≥ 0

End of time range as Unix timestamp (seconds since EPOCH). Must be greater than startTime.

string
enum
required

Time interval granularity for data aggregation. Determines whether data points represent minute, hour, or day intervals.

Allowed:
string
deprecated

Tunnel internal ID (e.g., 'bondedTunnel_33'). Maps to tunnelid in database. Deprecated: use tunnelAlias instead.

string
required

Tunnel display name/alias (e.g., 'to_datacenter_DefaultOverlay'). Maps to tunnelname in database. Required when tunnel is not provided.

string
enum

Response format. If 'csv', returns data as downloadable CSV file instead of JSON.

Allowed:
integer
1 to 10000
Defaults to 10000

Maximum number of data points to return. Default and maximum is 10000.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.ms-excel

Updated about 12 hours ago

Did this page help you?