Skip to content

Get Users' Sessions Log

Returns the array of records of users' sessions.

Request

HTTP Request

GET node/api/users/session/log

Permissions

read-session-log

Path parameters

No parameters required.

Query parameters

Parameter Type Description
from

integer
optional

A lower bound timestamp for session records.
limit

integer
optional

The maximum number of retrieved records.
skip

integer
optional

The number of records to be skipped, starting with the last record.
to

integer
optional

An upper bound timestamp for the session records.

Request body

The request body is empty.

Response

Field Type Description
endTime integer The timestamp for the end of the session.
expiredAt integer The timestamp for the expected end of the session due to user's inactivity.
id string Record's ID.
login string User's login.
startTime integer The timestamp for the beginning of the session.
userId string User's ID.

Examples

Request examples

login=<...>
password=<...>
saymon_hostname=<...>
url=http://$saymon_hostname/node/api/users/session/log

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users/session/log";
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));
let http = require('follow-redirects').http;
let fs = require('fs');

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = '/node/api/users/session/log';
let auth = 'Basic ' + Buffer.from(login + ':' + password).toString('base64');

let options = {
  'method': 'GET',
  'hostname': saymonHostname,
  'path': path,
  'headers': {
    'Authorization': auth
  },
  'maxRedirects': 20
};

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 = <...>
url = "http://" + saymon_hostname + "/node/api/users/session/log"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response example

[
    {
        "startTime": 1651662280161,
        "endTime": null,
        "expiredAt": 1651671819978,
        "userId": "5f5f420005a91e683e101ca7",
        "login": "admin",
        "id": "62725dc8bad91064e16e5910"
    }
]