Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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
languagejs
firstline1
linenumberstrue
GET /api/v1/report/feature/${returnType}

...

Applies filtering license usage data on all fields. To filter your data, use the following format:

Code Block
languagejs
firstline1
linenumberstrue
[{"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
languagejs
firstline1
linenumberstrue
{
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
languagejs
firstline1
linenumberstrue
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
languagejs
firstline1
linenumberstrue
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:

...

languagejs
firstline1
linenumberstrue

...

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:

EntityAPI Endpoints
FeatureFeature API
License ServerLicense Server API
License Server GroupLicense 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 tabAPI
License Server → Current UsageLicense Server Current Usage API
License Server → UptimeLicense Server Uptime API
License Server → Usage History

Usage History API (server)

Features → Current UsageCurrent Feature Usage API
Features → Usage HistoryUsage History API (feature)
Features → User History

User History API

Features → Utilization HistoryFeature Utilization History API
Features → DenialsDenials API
Reports → Current UsersCurrent Users API
Reports → Usage Per UserUsage Per User API
Reports → Usage History ComparisonUsage History API (features)
Reports → Current UtilizationCurrent Utilization API
Reports → Realtime Users Count

Realtime Users Count API

User Hosts List API

Reports → Expiring FeaturesExpiring Features API
Reports → Currently Borrowed LicensesCurrently Borrowed Licenses API
Reports → Current Usage Above 24 HoursCurrent Usage API (usage above/below N hours)
Reports → Current Usage On Multiple HostsCurrent Usage API (usage above/below N hours)