Page History

The Current Feature Usage endpoint delivers license usage metrics specific to the Current Feature Usage,License Statistics API allows you to obtain information about Current Feature Usage. The report consists of two parts: Current Feature Usage grid that shows usage at current moment, and Feature Usage chart, that shows how usage was shaped during the day allowing you to monitor statistics for the currently selected feature on the license server of your choosing.

Obtaining information about current feature usage

To get data You can easily fetch metrics about current feature usage use following URL template: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 proper value, according to your needs- the value that best suits your needs. The possible parameters are as follows: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}"
    }
]

 If your request is successful, you should see a response similar to the following: 

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

Response

On success, the report will contain one row for each license session for a specified feature. Each row consists of the following columns.

Column	Full name	Type	Description	Visible by default in export
uid	User Id	integer	Internal License Statistics identification of user that checked out licenses.	No
un	User	string	Name of user that checked out licenses.	Yes
hn	Host	string	Name of host where licenses were checked out to.	Yes
lus	Used

Field

Type

Description

uidintegerUser ID.

un

stringUsername.

hn

stringHostname.lus

	integer	Total number of licenses used by user on host.	Yes
lco

Checked Out

date and time

string

Date when

license was checked out, in 'YYYY-MM-DD HH:MM' format.

licenses were checked out.	Yes
tu	Time Used	string	How long the licenses have been in use. Note that you cannot filter on this field.	Yes
lbe	Borrow Expiration	date and time	Borrow expiration date. Returns an empty string if not applicable.	Yes
uil	User is from LDAP

lbe

string

Borrow expiration date, in 'YYYY-MM-DD HH:MM' format.

uil

boolean

Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.

msg

string

Error message returned on failure.

success

boolean

Indicates whether the API request was successfully processed. 

codeinteger

Error code for unsuccessful request.

totalCountinteger

Total number of all matching results.

Unavailable

Note that the order in the table is the default order of the columns in the exported file.

 Example

Say you would like to download data in a CSV file  If you want to obtain information about current feature usage for feature 1 in CSV format"1". To generate this data set, enter a command similar to this one: 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

To get data You can easily fetch metrics about feature usage during selected day use following URL template:a given day by sending the following HTTP request.

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

where :- $ $ indicates a variable value that you can replace with a proper value, according to your needs- the value that best suits your needs. The possible parameters are as follows:described below.

If your request is successful, you should see a response similar to the following: 

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

This report supports only JSON format.

Response

On success, this report will contain one row for each 5-minute-long period with usage statistic for the specified feature throughout the period.

Periods are from midnight, each 5 minutes (00:00-00:05, 00:05-00:10, 00:10-0:15, ...).

Each row consists of the following columns: