| Warning |
|---|
| This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
...
The User Hosts List endpoint delivers license usage metrics specific to the
Realtime Users Countreport, namely
...
"User history for last 14 days"; that is, a list of all user-on-host pairs
...
using a license on all realtime servers
...
over a given time period.
...
Obtaining information about user hosts
If you want to retrieve information about list of user on host pairs, we recommend that you send You can easily list user-on-host pairs by sending the following HTTP request.
| Code Block |
|---|
GET /api/v1/report/features/user-history/user-hosts/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows:described below.
| Parameter | Required | Type | Description | |
| ${returnType}returnType | Yes | string | Specifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdfStandard format option. See Making an API request for details. | |
| sd | Yes | stringdate | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. | |
| ed | Yes | stringdate | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27.rn | |
| standard report options | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. For CSV and JSON formats this parameter will be ignored. | |
| filter | No | json/string | Applies filtering license usage data on all fields. To filter by string column, use the following format:
| |
| fieldsVisibility | No | json/string | Specifies field visibility settings, like this:
where "1" indicates that a specific field is visible and ''0" indicates that it is not. Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here. | |
| limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. | |
| offset | No | integer | Specifies the offset of the first row to return. | |
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: un | hnIf orderBy is provided, orderDirection is mandatory. | |
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. If orderDirection is provided, orderBy is mandatory. |
If your request is successful, you should see a response similar to the following:
...
...
{ success: ${success}, msg: ${message}, data: [{ "uid": ${userId}, "un": ${userName}, "hn": ${hostName}, "uil": ${userIsLdap} }], "code": ${errorCode}, "totalCount": ${totalNumberOfRecords}}| various | See Making an API request for details. |
Response
On success, this report will contain one row for each user that used any license in the specified time range and each host on which the license was used. Each row consists of the following columns.
where the response fields can be explained as follows:
unhnuil
| Column | Full name | Type | Description | Visible by default in export |
| uid | User ID | integer | Internal License Statistics identification of user that checked out licenses. |  Yes |
un | User | string | Name of the user that checked out licenses. | Yes |
hn | Host | string | The host where the user checked out licenses. | 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. |
msg
string
Error message returned on failure.
success
boolean
Indicates whether the API request was successfully processed.
Error code for unsuccessful request.
Total number of all matching results.
If you want to obtain information about which user on host pairs were using any licenses between 2017-01-01 and 2017-01-14 in CSV format, enter a command similar to this one:
 Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Example
The following example shows a command that downloads data in CSV format about user-on-host pairs that were using licenses for 2019-01-01 through 2019-01-14.
| Code Block | ||
|---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/features/user-history/user-hosts/csv?sd=20172019-01-01&ed=20172019-01-14" |
...