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
Obtaining information about feature usage during given day
To get data about feature usage during selected day use 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 proper value, according to your needs
- the possible parameters are as follows:
Parameter | Required | Type | Description |
|---|---|---|---|
| ${featureId} | Yes | integer | Id of feature for which you want to gather data |
| day | No | string | Date in format 'YYYY-MM-DD'. States for which day we want to get the data. If not provided defaults to today
|
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}
}
where the response fields can be explained as follows:
Field | Type | Description |
|---|---|---|
| fid | integer | Feature ID. |
| lud | string | Date And Time. |
| ltc | integer | License Total Count. |
| lumax | integer | Maximum Amount Of Used Licenses. |
| lbmax | integer | Maximum Amount Of Borrowed Licenses. |