Page History

The User History endpoint delivers metrics License Statistics collects from the monitored license server. This endpoint is used to fetch 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.

...

You can easily fetch metrics about usage history at a particular point in time by calling this sending the following HTTP GET 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 possible parameters are can be explained as follows:.

{"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}
}]
}

where the response fields can be explained as follows:.

Example 1

For example, say Say you would like to view obtain information about all sessions for feature "3" at a specific point in time point. To generate such this data set, enter a command that is 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"

...

Let's assume you would like to see obtain statistics about all sessions for feature "3 ordered by username " at a specific time point. In addition, you want your data to be ordered by username. To do 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"

...

Say you need to view the first 100 sessions for feature "3" at a specific time point. To do obtain this data set, you need to enter a command that is similar to the following: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"

...

$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 over for a given timeframe by calling this HTTP GET request:time period by sending the following HTTP request.

GET /api/v1/report/feature/${featureId}/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 are can be explained as follows:.

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

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

uid, un, hn, sst, set 

If your request is successful, you should see a response similar to the following: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}
]}

The following code block shows an example result of a successful request:where the response fields can be explained as follows.

Example 1

For example, say Say you would like to view all sessions for feature "3 over some period of time" over a given timeframe. To generate such this data set, enter a command that is similar to the following:.

curl --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"

...

Let's assume you want to see all sessions for feature "3" for a given time period. Additionally, you would like your data to be ordered by username over a specific period of time. To do generate this data set, enter a command similar to the following:.

curl --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"

...

Let's assume you're interested in viewing the first 100 sessions for feature "3" over a specific period of timetimeframe.  To do obtain this information, enter a command that is similar to the following:.

curl --data "limit=100" --data "offset=0" --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"

...