HomeGuidesAPI Reference
API Reference

Get appliance reachability time series data

Retrieves appliance reachability time series data for monitoring WebSocket connectivity status. Returns portal, orchestrator, and appliance reachability metrics at minute-level (day granularity) or daily-level (month granularity). The data source table and aggregation method changes based on granularity: 'day' uses minuteappliancereachability with raw values, 'month' uses dailyappliancereachability with sumMerge aggregation. Timezone is determined by the appliance's business hour configuration settings.

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').

date
required
^\d{4}-\d{2}-\d{2}$

Date for which to retrieve availability data. For 'day' granularity, provides minute-level data for this specific date. For 'month' granularity, provides daily data starting from this date's month.

string
enum
required
Defaults to day

Time granularity for aggregating reachability data. 'day' returns minute-level samples from minuteappliancereachability table. 'month' returns daily aggregated samples from dailyappliancereachability table.

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json