API Guide

Multiple time series for any entity which share metric_name and switch_id.
In this example it is a in_pkts time series for all interfaces of switch "2:222222".
Example 5 - Retrieving the Latest Metric Point per Time Series:
To fetch the latest metric value for any of the examples above use current time,
as a unix timestamp, for both start_time_unix and end_time_unix.
*Result*:
One metric point for each timeseries.
Optionally lters time series results by rank.
REQUEST
REQUEST BODY - application/json
{
metric_names* [string]
start_time_unix* integer
Start time, as unix timestamp in seconds, from which the metrics will be fetched. Applies to all time
series.
end_time_unix* integer
End time, as unix timestamp in seconds, up to which the metrics will be fetched. Applies to all time
series.
interval integer
Interval, in seconds, at which a metric point is retrieved within start_time and end_time unix. Applies
to
all time series. If a interval is not provided then a default interval is used.
Time Range Default Intervals:
* 0 days - 1 day -> 1 min
* 1 day - 1 week -> 1 hour
* 1 week - 1 month -> 3 hours
* 1 month + -> 1 day
Note: these default intervals are inputted in seconds. Used mins/hours/days terminology in
description only.
entity_id string
Unique identier of the entity.
function_name enum ALLOWED:RATE, MAX_OVER_TIME, AVG_OVER_TIME
Enum for supported metric function to apply to metrics data. E.g. 'rate()' function.
RATE is recommended to only be used for counters. Can only be used if a time range is provided.
OVER_TIME functions can only be used if a time range is provided.
tags [{
Array of object:
key string
value string
}]
rank {
name enum ALLOWED:TOPK, BOTTOMK
Enum for supported lter of metrics time series data. This is used for topk or bottomk time series.
count integer
Number of timeseries to return from ranking.
}
}
RESPONSE
STATUS CODE - 200: Response for getting metric time series
RESPONSE MODEL - application/json
{
Metric time series.
start_time_unix integer
Start time, as unix timestamp in seconds, at which the metrics were fetched.
end_time_unix integer
End time, as unix timestamp in seconds, up to which the metrics were fetched.
interval integer
Interval at which metrics were fetched.
metrics [{
Array of object: Set of metric time series.
metric_name string
211 of 340