| 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 Count report, 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 frameperiod.
Obtaining information about user hosts
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) |
...
| Parameter | Required | Type | Description | ||||||||
| ${returnType} | Yes | string | Specifies the format in which license usage data will be returned. The format can be one of the following: JSON, CSV, 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.The date is in YYYY-MM-DD format; for example, 2017-05-20. | ||||||||
| ed | Yes | stringdate | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-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 XLSX. For CSV and JSON formats this parameter will be ignored. | filter | No | json/string |
| Code Block | ||
|---|---|---|
| ||
[
{
"type": "string",
"field": "${ un | hn }",
"value": "${value}"
}
] |
Specifies field visibility settings, like this:
| Code Block | ||
|---|---|---|
| ||
{
"uid": "1",
"un": "1",
"hn": "1"
} |
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.
Specifies the field by which you want to order your data records. The field name can be one of the following:
uid | un | hn(See this section for more field-specific information.)
If orderBy is provided, orderDirection is mandatory.
Response
...
| Code Block | ||
|---|---|---|
| ||
{
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.
...
un
hn
uil
| 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 your API request was successfully processed.
Error code for unsuccessful request.
 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 20172019-01-01 through 20172019-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" |