Page History

...

...

The User History endpoint delivers license usage metrics specific to the User History report, allowing you to see statistics for license usage per user, during any period that usage was tracked.

Anchor
feature feature

Showing sessions at a specific point in time

You can easily fetch metrics about usage history at a particular point in timeuser session history by sending the following HTTP request.

GET /api/v1/report/feature/${featureId}/user-history/${returnType}?sdt=${sessionDateTime}&(additional parameters, as needed)

where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.

{"un": "1", "hn": "1", "sst": "1", "set": "1"}

[{"value": intOrString, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}]

uid, un, hn, sst, set

The following code block shows an example result of a successful request.

{
success: true, 
msg: ${message}, 
data: [{
  uid: ${userId}, 
  un: ${userName},
  hn: ${hostName},
  sst: ${sessionStartTime},
  set: ${sessionEndTime},
  il: ${hasUserLdapDetails}
}]
}

...

Note: Either "sdt" or both "ssd" and "sed" must be specified.

Response

On success, this report will contain:

• if parameter "sdt" was used, one row for each session that started before or at the specified point in time and ended after or upon the specified point in time.
• if parameters "ssd" and "sse" were used, one row for each session that overlaps with the specified time range.

Field	Full name	Type	Description	Visible by default in export
uid	User ID	integer	User ID.	No
un	User	string	Username.	Yes
hn	Host	string	Hostname.	Yes
sst	Start Time	date and time	Time when the license was checked out.	Yes
set	End Time	date and time/string	Time when the license was checked in, or "Still in use."	Yes
tu	Time Used	string	How long the license has been in use. Note that you cannot filter on this field.	Yes
uil	User is from LDAP

...

Field	Type	Description
uid	integer	User ID.
un	string	Username.
hn	string	Hostname.
sst	string	Date returned in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00.
set	string	Date returned in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00, "Unknown" or "Still in use".
il	boolean	Indicates whether user details have been imported from the 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.
Unavailable

Note that order in table is default order of columns in exported file.

Example 1

The following example shows a command that lets you Example 1Say you would like to obtain information about all sessions for feature "3" at a specific specified time point in time. To generate this data set, enter a command similar to the following.

curl --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

Example 2

Let's assume you would like to The following example shows a command that lets you obtain statistics about all sessions for feature "3" at a specific specified time point. In addition, you want your data to be ordered by username. To generate this data set, enter a command similar to the following.

curl --data "orderBy=un" --data "orderDirection=ASC" --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

Example 3

Say you need to The following example shows a command that lets you view the first 100 sessions for feature "3" at a specific specified time point. To obtain this data set, enter a command that is similar to the one you can see below.

curl --data "limit=100" --data "offset=0" --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

Sample script

Example 4

The following example shows a command that lets you view all sessions for feature "3" for a specified time periodThis sample PowerShell 3.0 script serves as a template for generating PDF reports to a file for features with a specific name and for a license server of your choosing. The script saves reports to a file under a filename that follows the pattern: UserHistory-${featureId}.pdf. You can easily adapt this script to any target parameters you'd like to use to generate the desired report. The number of generated PDF files corresponds to the number of features meeting the defined criteria.

$token = "Yourtoken"
$url = "http://yourdomain/api/v1/report"
$features = Invoke-RestMethod "$($url)/feature/json?fns=FeatureName&lsn=LicenseServerName" -Headers @{"X-Auth-token"="$($token)"}

for ($i=0; $i -lt $features.data.fid.Length; $i++) { 
    Invoke-RestMethod "$($url)/feature/$($features.data.fid[$i])/user-history/pdf?sdt=2016-02-03 00:00" -Headers @{"X-Auth-token"="$($token)"} -OutFile "UserHistory-$($features.data.fid[$i]).pdf"
}

Showing sessions for a given time period

You can easily fetch metrics about usage history for a given time period by sending the following HTTP request.

GET curl --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/${featureId}3/user-history/${returnType}?ssd=${sessionStartDate}&sed={sessionEndDate}&(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 can be explained as follows.

...

Specifies the start date for which the report will be generated The date is in YYYY-MM-DD format; for example, 2017-05-20.

...

Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27.

...

{"un": "1", "hn": "1", "sst": "1", "set": "1"}

...

json"

Example 5

The following example shows a command that lets you see all sessions for feature "3" for a specified time period, and orders the data by username.

...

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

...

[{"value": intOrString, "field": "${un | hn | sst | set}"}]

...

Specifies the field by which you want to order your data records. The field name can be one of the following:

uid, un, hn, sst, set 

(See this section for more field-specific information.)

...

The following code block shows an example result of a successful request.

{success: true, msg: ${message}, data: [
  uid: ${userId}, 
  un: ${userName},
  hn: ${hostName},
  sst: ${sessionStartTime},
  set: ${sessionEndTime},
  il: ${hasUserLdapDetails}
]}

where the response fields can be explained as follows.

...

Say you would like to view all sessions for feature "3" over a given timeframe. To generate this data set, enter a command similar to the following.

curlcurl --data "orderBy=un" --data "orderDirection=ASC" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

Example 26

The following example shows a command that lets you view the first 100 Let's assume you want to see all sessions for feature "3" for over a given specified time period. Additionally, you would like your data to be ordered by username. To generate this data set, enter a command similar to the following.

curl --data "orderBylimit=un100" --data "orderDirectionoffset=ASC0" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

Example 3

Sample script 1

This sample PowerShell 3.0 script serves as a template for generating PDF reports to a file for features with a specific name and for a license server of your choosing. The script saves reports to a file under a filename that follows the pattern: UserHistory-${featureId}.pdf. You can easily adapt this script to any target parameters you'd like to use to generate the desired report. The number of generated PDF files corresponds to the number of features meeting the defined criteriaLet's assume you're interested in viewing the first 100 sessions for feature "3" over a specific timeframe.  To obtain this information, enter a command similar to the following.

curl$token --data= "limit=100" --data "offset=0" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H Yourtoken"
$url = "http://yourdomain/api/v1/report"
$features = Invoke-RestMethod "$($url)/feature/json?fns=FeatureName&lsn=LicenseServerName" -Headers @{"X-Auth-token"="$($token)"}

for ($i=0; $i -lt $features.data.fid.Length; $i++) { 
    Invoke-RestMethod "$($url)/feature/$($features.data.fid[$i])/user-history/pdf?sdt=2016-02-03 00:00" -Headers @{"X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json"

...

"="$($token)"} -OutFile "UserHistory-$($features.data.fid[$i]).pdf"
}

Sample script 2

This sample PowerShell 3.0 script can be used as a template for generating PDF reports to a file for features with a specific name and for a license server of your choosing. The script saves reports to a file under a filename that follows the pattern: UserHistoryForPeriod-${featureId}.pdf. You can easily adapt this script to any target parameters you'd like to use to generate the desired report. The number of generated PDF files corresponds to the number of features meeting the defined criteria.

...