Toggle menu

getActiveStats

Description

Returns a count of active sessions in a supplied time period and a total count of all sessions.

Parameters

NameTypeDescription
endString, requiredAn ISO datetime. Get sessions last updated before this time
startString, requiredAn ISO datetime. Get sessions last updated after this time

Example Request

function(params, credentials) {
    let result = this.callWorkerMethod('sitesessionstore', 'getActiveStats', {
        "start":"2023-08-01T13:20:00Z",
        "end":"2023-08-01T15:00:00Z"
    });
    return result;
}

Response

NameTypeDescription
numActiveSessionsIntegerThe total number of sessions
numActiveSessionsInPeriodIntegerThe number of active sessions in the defined time period

Example Response

{
    "id": 85,
    "result": {
        "numActiveSessions": 1,
        "numActiveSessionsInPeriod": 0
    },
    "jsonrpc": "2.0"
}

Last modified on 1 August 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon