Some information on this page refers to License Statistics v5.4 9 or newer, which introduced a versioned endpoint URL path in order to maintain version integrity into the future. |
To obtain information about the License Statistics features, use the following request:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/feature/${returnType} |
...
Applies filtering license usage data on all fields. To filter your data, use the following format:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[{"type": "${string | numeric}", "value": stringOrNumericValue, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}] |
...
Note: By default, filter rules are case-insensitive.
Response
The response you get may be similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
success: true,
msg: ${message},
data: [{
fid: ${featureId},
fns: ${featureName},
fv: ${featureVersion},
ftype: ${featureType},
lsid: ${licenseServerId},
lsn: ${licenseServerName},
vn: ${licenseServerVendorName},
gtn: ${licenseServerGatheringType}
}]
} |
where the response fields can be explained as follows:
...
Examples
The following examples make use of GET method.
- To get the list of all License Statistics features, type the following from a command line:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
- To obtain feature information filtered by name, version and type, enter the following command:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "fns=a&fv=2.1&ftype=floating" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
- To get feature information filtered by Id, enter the following command:
...
language | js |
---|---|
firstline | 1 |
linenumbers | true |
...
Most reports in License Statistics are based around specific core entities. Below you can see their names as well as API endpoints you can use to get more information about them:
Entity | API Endpoints |
---|---|
Feature | Feature API |
License Server | License Server API |
License Server Group | License Server Group API |
Say you want to obtain data that is displayed in License Statistics in a format of JSON or CSV/XLS/PDF reports, below you can find a list of API you can use:
License Statistics tab | API |
---|---|
License Server → Current Usage | License Server Current Usage API |
License Server → Uptime | License Server Uptime API |
License Server → Usage History | |
Features → Current Usage | Current Feature Usage API |
Features → Usage History | Usage History API (feature) |
Features → User History | |
Features → Utilization History | Feature Utilization History API |
Features → Denials | Denials API |
Reports → Current Users | Current Users API |
Reports → Usage Per User | Usage Per User API |
Reports → Usage History Comparison | Usage History API (features) |
Reports → Current Utilization | Current Utilization API |
Reports → Realtime Users Count | |
Reports → Expiring Features | Expiring Features API |
Reports → Currently Borrowed Licenses | Currently Borrowed Licenses API |
Reports → Current Usage Above 24 Hours | Current Usage API (usage above/below N hours) |
Reports → Current Usage On Multiple Hosts | Current Usage API (usage above/below N hours) |