Get Link's Stat
Returns agent's data (stat) of a link with the specified ID.
Request
HTTP Request
Permissions
Path parameters
Parameter | Type | Description |
---|---|---|
id | Stringrequired |
The ID of a link whose agent's data should be retrieved. |
Request body
The request body is empty.
Response
Returns a requested link's stat. See the Stat for more information.
Example
Request
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/stat";
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");
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/stat";
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();
Response
{
"entityId": "5e8721f6a82a7421a9a3521a",
"entityType": "link",
"payload": {
"packetsTransmitted": 4,
"packetsReceived": 4,
"packetLossPercentile": 0,
"numberOfErrors": 0,
"numberOfDuplicates": 0,
"roundTripMinimal": 12.667,
"roundTripAverage": 114.142,
"roundTripMaximum": 416.788
},
"period": -1,
"timestamp": 1586257729767
}