Current Feature Usage API

The Current Feature Usage endpoint delivers license usage metrics specific to the Current Feature Usage, allowing you to monitor statistics for the currently selected feature on the license server of your choosing.

Obtaining information about current feature usage

You can easily fetch metrics about current feature usage for a given feature by sending the following HTTP request.

GET /api/v1/report/feature/${featureId}/current-usage/${returnType}

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

{ "uid": "1", "un": "1", "hn": "1", "lus": "1", "lco": "1", "tu": "1", "lbe": "1" }

[
    {
        "type": "string",
        "field": "${un | hn | lco | lbe}",
        "value": "${value}"
    }
]

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

uid, un, hn, lus, lco, tu, lbe

Response

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

{
    success: ${success},
    msg: ${message},
    data: [{
        "uid": ${userId},
        "un": ${userName},
        "hn": ${hostName},
        "lus": ${licensesUsed},
        "lco": ${checkoutTime},
        "tu": ${licensesUsed},
        "lbe": ${borrowExpire},
        "uil": ${ldapUser}
    }],
    "code": ${errorCode},
    "totalCount": ${totalCount}
}

where the response fields can be explained as follows: 

 Example

Say you would like to download data in a CSV file about current feature usage for feature "1". To generate this data set, enter a command similar to the following.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/1/current-usage/csv"

Obtaining information about feature usage during given day

You can easily fetch metrics about feature usage during a given day by sending the following HTTP request.

GET /api/v1/report/feature/${featureId}/usage/chart/json?day=${day}

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

Response

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

{
    success: ${success},
    msg: ${message},
    data: [{
        "fid": ${featureId},
        "lud": ${dateAndTime},
        "ltc": ${totalCount},
        "lumax": ${licenseUsageMax},
        "lbmax": ${licensesBorrowedMax}
    }],
    "code": ${errorCode},
    "totalCount": ${totalCount}
}