Current Users API

The Current Users endpoint delivers license usage metrics specific to the Current Users report, allowing you to see currently active users and the features they are using.

Obtaining information about current users

You can easily list users who are currently using at least one license by sending the following HTTP request.

GET /api/v1/report/users/current/${returnType}

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

{ "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lsid": "1", "lsn": "1", "uid": "1", "un": "1", "hn": "1",  "lco": "1","lus": "1"}

[
    {
        "type": "string",
        "field": ""${un | hn | fns | fv | ftype | lsn | lco}",
        "value": "${value}"
    }
]

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${fid | lsid | lus }",
        "value": "${value}"
    }
]

 fid, fns, fv, ftype, lsid, lsn, uid, un, hn, lco, lus

Response

The following code block shows an example result of a successful request.

{
    success: ${success},
    msg: ${message},
    data: [{
        "fid": ${featureId},
        "fns": ${featureName},
        "ftype": ${featureType},
        "fv": ${featureVersion},
        "lsid": ${licenseServerId},
        "lsn": ${licenseServerName},
        "uid": ${userId},
        "un": ${userName},
        "hn": ${hostName},
        "lco": ${licenseCheckedOut},
        "lus": ${licensesUsed}
    }],
    "code": ${errorCode},
    "totalCount": ${totalCount}
}

Obtaining information about current license usage

You can easily list users that are currently using at least one license by sending the following HTTP request.

GET /api/v1/report/users/license/current-usage/json

You can filter your data results using the filter parameter, as described above.

Response

The following code block shows an example result of a successful request.

{
    "success": ${success},
    "msg": ${message},
    "data": [
        {          
            "hu": 1,           
            "tu": ${usersWithLicensesCount}
        },
        {          
            "hu": 0,           
            "tu": ${usersWithoutLicensesCount}
        }
    ],
    "code": ${code},
    "totalCount": 2
}

where the response fields can be explained as follows.

Example

Say you have many license servers, some of which are LM-X servers called 'lm-x 1', 'lm-x 2', etc. The following example shows a command that lets you identify how many users are using licenses from those particular servers.

curl --globoff -H "X-Auth-token: token" 'http://yourdomain/api/v1/report/users/license/current-usage/json?filter=[{"type":"string","field":"lsn","value":"lm-x"}]'

Obtaining information about highest license usage

You can easily list 10 users that are using the highest number of licenses by sending the following HTTP request.

GET /api/v1/report/users/license/highest-usage/json

You can filter your data results using the filter parameter, as described above.

Response

The following code block shows an example result of a successful request.

{
    "success": ${success},
    "msg": ${message},
    "data": [
        {          
            "un": ${userName},           
            "lus": ${usersWithLicensesCount}
        }
    ],
    "code": ${code},
    "totalCount": ${totalCount}
}

where the response fields can be explained as follows:

Example

The following example shows a command that lets you obtain information about users that have the highest usage of a feature named "super_feature" (in any version).

curl --globoff -H "X-Auth-token: token" 'http://yourdomain/api/v1/report/users/license/highest-usage/json?filter=[{"type":"string","field":"fns","value":"super_feature"}]'