Current Feature Usage API

The Current Feature Usage API delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch 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

If you want to fetch metrics about current feature usage for a given feature, use the following URL request template.

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 and the possible parameters are as follows:

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

 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 want to obtain information about current feature usage for feature 1 in CSV format. To fetch such metrics, enter a command similar to this one: 

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

Obtaining information about feature usage during given day

If you want to fetch metrics about feature usage during any selected day, use the following URL template:

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 and the possible parameters are as follows:

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}
}