Page tree
Skip to end of metadata
Go to start of metadata

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.

Parameter
Required
Type
Description
${featureId}YesintegerInternal LicStat identification of the feature for which you want to view current usage.
${returnType}YesstringStandard format option. See Making an API request for details.
standard report options Novarious

See Making an API request for details.

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.

Minus (-) 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

integer

Total number of licenses used by user on host.

Yes

lco

Checked Out

date and time

Date when licenses were checked out.

Yes
tuTime Usedstring

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

boolean

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

Error (x) 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 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=${YYYY-MM-DD}

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

Parameter
Required
Type
Description
${featureId}YesintegerInternal License Statistics identification of the feature for which you want to get data.
day NodateIndicates day for which you want to gather data. If not provided, it defaults to today.

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: 


Column
Full name
Type
Description
fidFeature IDintegerReturn specified feature ID from request.
ludPeriod Startdate and timeBeginning of the period.
ltcTotalintegerTotal number of licenses available for feature in the period.
lumaxMax UsedintegerMaximum amount of used licenses during the period.
lbmaxMax BorrowedintegerMaximum amount of borrowed licenses during the period.