| The information on this page refers to License Statistics versions prior to v6.3. This information no longer applies to License Statistics v6.3 and newer. |
The Usage Per User endpoint delivers license usage metrics specific to the Usage Per User report for selected types of aggregation (usernameuser, hostnamehost, username user and hostnamehost, usergroup, hostgroup) over a given time period.
...
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${featureId} | Yes | integer | Internal License Statistics identification of the feature for which you want to view usage history. |
| ${licenseServerId} | Yes | integer/string | Internal License Statistics identification of the license server for which you want to view usage history, or "all" if information about all license servers is requested. |
| ${returnType} | Yes | string | Standard format option. See Making an API request for details. |
| sd | Yes | date | Start date for which the report will be generated. |
| ed | Yes | date | End date for which the report will be generated. |
| grat | Yes | enumeration | Period type the result is aggregated for. HOUR granularity is not supported. See granularity descriptions for further details. |
| agrt | No | integer | Type of aggregation of the returned data. Aggregation type can be one of the following:
By default, data is aggregated by username user and hostname host (3). |
| standard report options | No | various | See Making an API request for details. |
...
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| fud | Date | string | The time period. Format depends on granularity. |   Yes |
| uid | User ID | string | Internal License Statistics identification of the user for aggregations Username User(1) and Username User and hostnameHost(3). Otherwise, a semicolon-separated list of user IDs. |   Unavailable |
| un | UsernameUser | string | Name of the user for aggregations Username User(1) and Username User and hostnamehost(3). Otherwise, a semicolon-separated list of usernames. | Yes |
| uil | User is from LDAP | string | Information about whether the user is managed by LDAP for aggregations UsernameUser(1) and Username User and hostnamehost(3). Otherwise, a null value. | Unavailable |
| ugn | User Group | string | Name of user group for aggregations Usergroup(4). Otherwise, an empty string. |  Only for aggregation Usergroup(4) |
| hn | HostnameHost | string | Hostname for aggregations HostnameHost(2) and Username User and hostnamehost(3). Otherwise, a semicolon-separated list of hostnames. | Yes |
| hgn | Host Group | string | Name of host group for aggregations Hostgroup(5). Otherwise, an empty string. | Only for aggregation Hostgroup(4) |
| lsid | License Server ID | integer | Internal License Statistics identification of the license server hosting the feature. | Unavailable |
| lsn | License Server | string | Name of the license server hosting the feature. | Yes |
| fid | Feature ID | integer | Internal License Statistics identification of the feature. | Unavailable |
| fns | Feature Name | string | Feature name. | Yes |
| fv | Feature Version | string | Feature version. | Yes |
| ftype | Feature Type | enumeration | See feature type descriptions for details. | Yes |
| musage | Max Usage | float | Maximum usage of licenses in relation to total number of licenses in the period, expressed in percentages. | Yes |
| hu | Hours Used | float | Cumulative time used by all licenses of the feature in the period, in hours. | Yes |
| mu | Max Used | integer | Maximum number of licenses of the feature used in the period. | Yes |
| hb | Hours Borrowed | float | Cumulative time of all license borrows of the feature in the period, in hours. | Yes |
| mb | Max Borrowed | integer | Maximum number of licenses of the feature borrowed in the period. | Yes |
Note that the order in the table is the default order of the columns in the exported file.