Page History

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

Obtaining information about usage history for feature

Anchor
obtain obtain

...

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

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

...

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

 - the possible parameters are as follows:

[
	{ 
		"type": "string",
		"field": "lud",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft}",
		"value": "${value}" 
	}
]

{ 
	"lud": "1", 
	"lumin": "1", 
	"lua": "1", 
	"lumax": "1", 
	"lbmin": "1", 
	"lbmax": "1", 
	"ldtc": "1", 
	"hu": "1", 
	"ft": "1"
}

lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft

...

where the response fields can be explained as follows:

...

Obtaining information about usage history comparison for feature

If you want to obtain information about usage history comparison for feature comparison, you have to use we recommend that you use the following URL request template.

GET /api/v1/report/usage-history/comparison/json?fi=${featureIds}&sd=${startDate}&ed=${endDate}&granularity=${granularity}

The possible Possible parameters are as follows:

Currently this the report is only returned only in jsonJSON syntax. There are plans to introduce csvCSV, xls XLS and pdf 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}
}

The meaning of all fields are where the fields carry the same values as in Usage History For Feature.

...

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, you have to use 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)

The possible Possible parameters are as follows:

[
	{ 
		"type": "string", 
		"field": "${lud | fns | fv | ftype}",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"field": "${lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft}",
		"value": "${value}"
	}
]

{ 
	"lud": "1", 
	"lumin": "1", 
	"lua": "0", 
	"lumax": "1", 
	"lbmin": "1", 
	"lbmax": "1", 
	"ldtc": "1", 
	"hu": "0", 
	"ft": "0",
	"fns": "1",
	"fv": "1",
	"ftype": "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:

...

where the response fields can be explained as follows:

If any of the requests has invalid or missing paramsparameters, HTTP 400 BAD REQUEST is returned.