Page History

License Statistics API allows you to generate data from the Usage Per User report. This report shows statistics for license usage by users, during any period that usage was tracked.

Obtaining information about usage

...

per user for feature

Anchor
obtain obtain

If you want to retrieve information about usage history per user for a single feature, we recommend that you use the following URL request template.

...

Obtaining information about usage

...

per user for license server

If you want to obtain retrieve information about usage history comparison for features, per user for license servers we recommend that you use the following URL request template.

GET GET /api/v1/report/license-server/${licenseServerId}/usage-per-history/comparison/json?fi=user/${featureIdsreturnType}&?sd=${startDate}&ed=${endDate}&granularitygrat=${granularity}$(additional parameters, as needed)

where

 - $ indicates a variable value that you can replace with a proper value, according to your needs

 - possible parameters are as followsPossible parameters are as follows:

Currently the report is only returned only in JSON syntax. There are plans to introduce CSV, XLS and PDF formats in the future.

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

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{
      		"fid": ${featureId_1},
      		"lud": ${date},
      		"lumin": ${minUsed},
      		"lua": ${averageUsed},
      		"lumax": ${maxUsed},
      		"lbmin": ${minBorrowed},
      		"lbmax": ${maxBorrowed},
      		"ldtc": ${denials},
      		"hu": ${hoursUsed},
      		"ft": ${total}
    	},
		{
      		"fid": ${featureId_2},
      		"lud": ${date},
      		"lumin": ${minUsed},
      		"lua": ${averageUsed},
      		"lumax": ${maxUsed},
      		"lbmin": ${minBorrowed},
      		"lbmax": ${maxBorrowed},
      		"ldtc": ${denials},
      		"hu": ${hoursUsed},
      		"ft": ${total}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

where the fields have the same values as the ones explained in Obtaining information about usage history for feature, above.

Obtaining information about usage history for license server

If you want to obtain information about usage history for all visible features for a given server, we recommend that you use the following URL request template.

GET /api/v1/report/usage-history/license-server/${lsid}/${returnType}?sd=${startDate}&ed={endDate}&granularity=${granularity}$(additional parameters, as needed)

Possible parameters are as follows:

[
	{ 
		"type": "string",

		"

field": "lud",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${

fud | un | hn | lsn | fns | 

fv | 

ftype | 

musage | 

hu | 

mu | 

hb | 

mb}",
		"value": "${value}" 
	}
]

{ 
	"

fud": "1", 
	"

un": "1", 
	"

hn": "

1", 
	"

lsn": "1", 
	"

fns": "1", 
	"

fv": "1", 
	"

ftype": "1", 
	"

musage": "

1", 
	"

hu": "

1", 
	"

mu": "1",

	"

hb": 

"1

lud | fns | fv | ftype | fid | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft

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

", 
	"mb": "1"
}

fud | un | hn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb

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

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{      		
			"fid": ${featureId},

{
	"success": ${success},
	"msg": ${message},
  	"data": [
    	{
      		"fid": ${featureId_1},
      		"lud": ${date},
      		"lumin": ${minUsed},
      		"lua": ${averageUsed},
      		"lumax": ${maxUsed},
      		"lbmin": ${minBorrowed},
      		"lbmax": ${maxBorrowed},
      		"ldtc": ${denials},
      		"hu": ${hoursUsed},
      		"ft": ${total},
			"fnslsid": ${featureNamelicenseServerId},	
			"ftypeuid": ${featureTypeuserId},
			"fvuil": ${featureVersion}
    	},
		{userIsLdap},
      		"fidfud": ${featureId_1date},
      		
			"ludun": ${dateusername},
      		
			"luminhn": ${minUsedhostname},
      		"lualsn": ${averageUsedlicenseServerName},
      		"lumaxfns": ${maxUsedfeatureName},
      		"lbminfv": ${minBorrowedfeatureVersion},
      		"lbmaxftype": ${maxBorrowedfeatureType},
      		"ldtcmusage": ${denialsmaxUsage},
      		"hu": ${hoursUsed},
      		"ftmu": ${totalmaxUsed},
      			"fnshb": ${featureNamehoursBorrowed},
			"ftype": ${featureType},
	      		"fvmb": ${featureVersionmaxBorrowed}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

where the response fields can be explained as follows:

...