Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Some information on this page refers to License Statistics v5.4 or newer, which introduced a versioned endpoint URL path in order to maintain version integrity into the future.

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.

...

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

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

...

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

...

Code Block
languagejs
firstline1
linenumberstrue
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/user-history/3/json"

...

Code Block
languagejs
firstline1
linenumberstrue
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/user-history/3/json"

...

Code Block
languagejs
firstline1
linenumberstrue
$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)/user-history/$($features.data.fid[$i])/pdf?sdt=2016-02-03 00:00" -Headers @{"X-Auth-token"="$($token)"} -OutFile "UserHistory-$($features.data.fid[$i]).pdf"
}

...

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

...

Code Block
languagejs
firstline1
linenumberstrue
curl --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/user-history/3/json"

...

Code Block
languagejs
firstline1
linenumberstrue
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/user-history/3/json"

...

Code Block
languagejs
firstline1
linenumberstrue
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/user-history/3/json"

...

Code Block
languagejs
firstline1
linenumberstrue
$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)/user-history/$($features.data.fid[$i])/pdf?ssd=2016-02-03&sed=2016-02-10" -Headers @{"X-Auth-token"="$($token)"} -OutFile "UserHistoryForPeriod-$($features.data.fid[$i]).pdf"
}

...