Page History

License Statistics API allows you to obtain information about Current Users report. The report consists of three parts: current license usage, highest license usage and current users list.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

To You can easily list users that who are currently using licenses, use following URL templateat 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 proper value, according to value that best suits your needs - the and possible parameters are as follows:

{ "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

If your request is successful, you should see a response similar to the following: 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

To obtain information about how many users are using licenses at the moment, use following URLYou 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

Data can be filtered in the same manner as current users report above.

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

The following code block shows an example result of a successful requestIf your request is successful, you should see a response similar to the following:

{
    "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 server. Among them several servers, some of which are LM-X servers called 'lm-x 1', 'lm-x 2', and so onetc. To find out how many users are using licenses (only) from those servers, use:enter a command similar to the following.

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

To get to know You can easily list 10 users that used most license, use following URLare using the highest number of licenses by sending the following HTTP request.

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

Data can be filtered using parameter in the same manner as current users report above.

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

The following code block shows an example result of a successful requestIf your request is successful, you should see a response similar to the following:

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

...

Example

Say you have a feature called 'super_feature' . To find out which users and you would like to obtain information about users that use this feature (in any version) the most, use:. To generate this data set, enter a command similar to the following.

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"}]'