Versions Compared

Old Version 12

changes.mady.by.user Unknown User (mkos)

Saved on

compared with

New Version 13

changes.mady.by.user Tracy McCurdy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The User Hosts List endpoint delivers license usage metrics specific to the Realtime Users Count report, namely "User history for last 14 days", i.e. ; that is, a list of all user on host pairs using a license on all realtime servers over a given timeframetime frame.

Obtaining information about user hosts

...

Code Block
GET /api/v1/report/features/user-history/user-hosts/${returnType}?sd=${startDate}&ed=${endDate}&(additional parameters, as needed)

where $ indicates a variable value that you can replace with a value that best suits your needs and . The possible parameters are as follows:described below.

ParameterRequiredTypeDescription
returnTypeYesstringSpecifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf.
sdYesstringSpecifies the start date for which the report will be generated.The date is in YYYY-MM-DD format; for example, 2017-05-20.
edYesstringSpecifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27.
rn

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.
If you don't pass this parameter, it will be generated automatically for PDF and XLS/XLSX types. If provided, it cannot be left empty.

filterNojson/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format:

 

Code Block
linenumberstrue
[
    { 
        "type": "string",
        "field": "${ un | hn }",
        "value": "${value}"
    }
]


fieldsVisibilityNojson/string

Specifies field visibility settings, like this:

 

Code Block
linenumberstrue
{
    "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.

limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

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.

orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. If orderDirection is provided, orderBy is mandatory.

...

FieldTypeDescription
uidintegerUser ID.

un

stringUsername.

hn

stringHostname.

uil

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. 

codeinteger

Error code for unsuccessful request.

totalCountinteger

Total number of all matching results.

 Example

Say you would like to download The following command downloads data in CSV format about user on host pairs that were using licenses for 2017-01-01 through 2017-01-14. To generate this data set, enter a command similar to the following.

Code Block
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/features/user-history/user-hosts/csv?sd=2017-01-01&ed=2017-01-14"

...