User History report

The License Statistics API lets you generate data from the User History report. This report shows statistics for license usage per user, during any period that usage was tracked.

Showing sessions at a specific point in time

If you want to retrieve information about usage history at a particular point in time, we recommend that you use the following URL request template.

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

where:

- $ indicates a variable value that you can replace with an appropriate value, as needed

- the possible parameters are as follows:

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

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

If your request is successful, you should see a response similar to the following:

{
success: true, 
message: ${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 you would like to view all sessions for feature 3 at a specific time point. To generate such data, 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/report/user-history/3/json"

Example 2

Let's assume you would like to see all sessions for feature 3 ordered by username at a specific time point. To do this, enter a command similar to the following:

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

Example 3

Say you need to view the first 100 sessions for feature 3 at a specific time point. To do this, you need to enter a command similar to the following:

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

Showing sessions over a specific time period

If you want to retrieve information about usage history over a specific period of time, we recommend that you use the following URL request template:

GET /api/report/user-history/${featureId}/${returnType}?ssd=${sessionStartDate}&sed={sessionEndDate}&(additional parameters, as needed)

where:

- $ indicates a variable value that you can replace with an appropriate value, as needed

- the possible parameters are as follows:

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

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

If your request is successful, you should see a response similar to the following:

{success: true, message: ${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 you would like to view all sessions for feature 3 over some period of time. To generate such data, 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/report/user-history/3/json"

Example 2

Let's assume you want to see all sessions for feature 3 ordered by username over a specific period of time. To do this, enter a command similar to the following:

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

Example 3

Let's assume you're interested in viewing the first 100 sessions for feature 3 over a specific period of time. To do this, 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/report/user-history/3/json"