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

Get interface availability timeseries data

get
http://127.0.0.1:8080/stats/timeseries/availability/interface

Retrieves interface availability timeseries data for a specific appliance and interface. Returns availability state data points aggregated based on granularity. For 'day' granularity, queries minuteinterfaceavailability table with minute-level resolution. For 'month' granularity, queries dailyinterfaceavailability table with daily aggregated values including interface count and sample count.

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

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

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

string
required

Interface name identifier to filter statistics for a specific network interface.

string
enum
required
Defaults to day

Data aggregation granularity. 'day' returns minute-level data points for a single day. 'month' returns daily aggregated data points for the entire month.

Allowed:
Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permission for this resource.

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?