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

Get aggregated appliance reachability statistics

get
http://127.0.0.1:8080/stats/aggregate/availability/appliance

Retrieves aggregated appliance reachability statistics showing portal, orchestrator, and appliance connectivity metrics. Validates appliance version compatibility (requires 9.5.0, 9.4.2, 9.3.4 or higher). Data is retrieved from ClickHouse database tables (dailyappliancereachability or monthlyappliancereachability) based on granularity.

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}$

Query date in YYYY-MM-DD format. For 'month' granularity, use first day of month (e.g., '2024-01-01').

string
enum
required

Time aggregation period. 'day' returns daily stats, 'week' returns weekly stats, 'month' returns monthly stats.

Allowed:
Responses

Updated about 11 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

Updated about 11 hours ago

Did this page help you?