HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_monitors/{NAE_Monitor.name}/time_series/{Time_Series.type}

Path Params
string
required

Reference Resource: NAE_Script
Name of a NAE Script. This has to be a valid canonical name (CNAME) (i.e com.arubanetworks.bgp_monitor).

string
required

Reference Resource: NAE_Agent
Name of a NAE Agent. This has to be a CNAME starting with NAE Script name followed by its own name (i.e com.arubanetworks.bgp_monitor.agent1).

string
required

Reference Resource: NAE_Monitor
Monitors created by the particular NAE Agent.

string
required

Reference Resource: Time_Series
Time series associated with the monitor. The possible time series are: 'Rate': When the monitored URI is wildcarded,this function finds the rate. 'Raw' : Regular raw data points in the time series. 'Count': This counts the number of distinct time-series that have been generated and implicitly reflects the 'count' of data points collected every scrape interval. 'Sum': When the monitored URI is wildcarded, this function sums over the current values of 'all' resources pointed to by expanding on the wildcard. 'Min/Max': When the monitored URI is wildcarded,these functions return the min/max of the current value of 'all' currently present resource pointed to by expanding on the wildcard. 'Average': This function performs an average over the current value of 'all' currently present resources pointed to by expanding on the wildcard. 'CountOverTime', 'SumOverTime', 'MinOverTime', 'MaxOverTime', 'AverageOverTime': When the keyword 'OverTime' follows one of the aggregators defined above,the function behaves in a similar way but performs its aggregation 'over' the specified time in the past instead of over the current value only. 'Count_Rate', 'Count_CountOverTime', 'Count_Sum', 'Count_SumOverTime', 'Count_Min', 'Count_MinOverTime', 'Count_Max', 'Count_MaxOverTime', 'Count_Average', 'Count_AverageOverTime', 'Sum_Rate', 'Sum_Count', 'Sum_CountOverTime', 'Sum_SumOverTime', 'Sum_Min', 'Sum_MinOverTime', 'Sum_Max', 'Sum_MaxOverTime', 'Sum_Average', 'Sum_AverageOverTime', 'Min_Rate', 'Min_Count', 'Min_CountOverTime', 'Min_Sum', 'Min_SumOverTime', 'Min_MinOverTime', 'Min_Max', 'Min_MaxOverTime', 'Min_Average', 'Min_AverageOverTime', 'Max_Rate', 'Max_Count', 'Max_CountOverTime', 'Max_Sum', 'Max_SumOverTime', 'Max_Min', 'Max_MinOverTime', 'Max_MaxOverTime', 'Max_Average', 'Max_AverageOverTime', 'Average_Rate', 'Average_Count', 'Average_CountOverTime', 'Average_Sum', 'Average_SumOverTime', 'Average_Min', 'Average_MinOverTime', 'Average_Max', 'Average_MaxOverTime', 'Average_AverageOverTime': Nested Aggregate Functions are when we combine functions to obtain the combined effect of the two functions, for example Sum(Rate(resource)) will initially compute the Rate then the Sum of the switch resource.

Query Params
attributes
array of strings

Columns to display.

attributes
integer

Depth to traverse.

string
enum

Select configuration, status and/or statistics. Default is all categories.

Allowed:
filter
array of strings

Filter rows by attribute values. Format: attribute:value

filter
string
enum

Count the number of rows found.

Allowed:
Headers
string

Entity-tag value for representation comparison (see RFC 7232 - Conditional Requests - section 3.2)

Responses

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

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