Get Link's Metrics History
Retrieves link's metric history.
Request
HTTP Request
Permissions
Path parameters
Parameter | Type | Description |
---|---|---|
id | Stringrequired |
The ID of a link whose metrics history should be retrieved. |
Query parameters
Parameter | Type | Description |
---|---|---|
metrics | Stringrequired |
A comma-separated list of metrics to be retrieved. |
from | Stringrequired |
A lower-bound timestamp of metrics' values. |
downsample | Stringoptional |
A down-sampling parameter. For example, 1m-avg or 1h-avg denote |
"one minute average" and "one hour average" accordingly. | ||
timezone | Stringoptional |
A timezone of metrics' values. For example, Europe/Moscow . Use this parameter if a server's timezone doesn't match your local one and you need to get metrics without time shift. |
to | Stringoptional |
An upper-bound timestamp of metrics' values. |
Request body
The request body is empty.
Response
Returns an array of requested metrics. Each metric contains the following fields:
Field | Type | Description |
---|---|---|
metric | String | Metric name. |
tags.entity | String | The ID of the entity prefixed by the type of the entity. The format is objectxxx for objects and linkxxx for links. |
aggregateTags | Array | Work In Progress |
dps | Array | An array of data points. Contains a timestamp and a value. |
Info
To get all available metrics for a link, use the Get Link Stat Metrics method.
Example
Request
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let queryParams = "metrics=packetsTransmitted,packetsReceived" +
"&" + "from=1580906276000";
let path = "/node/api/links/" + linkId + "/history" + "?" + queryParams;
let auth = "Basic " + btoa(login + ":" + password);
let headers = new Headers();
headers.append("Authorization", auth);
let requestOptions = {
method: "GET",
headers: headers
};
fetch(saymonHostname + path, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));
const http = require("http");
const querystring = require("querystring");
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let queryParams = querystring.stringify({
metrics : "packetsTransmitted,packetsReceived",
from : "1580906276000"
});
let path = "/node/api/links/" + linkId + "/history" + "?" + queryParams;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "GET",
"hostname": saymonHostname,
"headers": {
"Authorization": auth
},
"path": path
};
let req = http.request(options, function (res) {
let chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
let body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
import requests
login = <...>
password = <...>
saymon_hostname = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
link_id + "/history"
params = {
"metrics": "packetsTransmitted,packetsReceived",
"from": "1580906276000"
}
response = requests.request("GET", url, auth=(login, password), params=params)
print(response.text)
Response
[
{
"metric": "packetsTransmitted",
"tags": {
"entity": "link5e7df795f988c426bb37215e"
},
"aggregateTags": [],
"dps": [
[
1662121832050,
4
],
[
1662121839385,
4
]
...
]
},
{
"metric": "packetsReceived",
"tags": {
"entity": "link5e7df795f988c426bb37215e"
},
"aggregateTags": [],
"dps": [
[
1662121832050,
4
],
[
1662121839385,
4
]
...
]
}
]