Versions Compared

Old Version 71

changes.mady.by.user Tomasz Ryba

Saved on

compared with

New Version 72

changes.mady.by.user Tracy McCurdy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Some information on this page refers to License Statistics v5.9 or newer, which added a new API endpoint for fetching license usage metrics about usage history for license server groups. If you are running a previous version of License Statistics, please refer to the documentation for releases prior to v5.9.

The Usage History endpoint delivers licene license usage metrics specific to the Usage History report, allowing you to monitor statistics for license usage , during any period that usage was tracked.

...

ParameterRequiredTypeDescription
${featureId}Yesinteger

Specifies feature-specific parameters.

${returnType}YesstringSpecifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf.
sdYesstringSpecifies the start date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-20.
edYesstringSpecifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27.
granularityYesinteger

Specifies granularity of the returned data, which can be one of the following:

  • Quarter - 2
  • Month - 3
  • Week - 4
  • Day - 5
  • Hour - 6
rn

No

string

Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.

filterNojson/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format. 

Code Block
languagejs
linenumberstrue
[
	{ 
		"type": "string",
		"field": "lud",
		"value": "${value}"
	}
]

To filter by a numeric column, use the following format.

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


fieldsVisibilityNojson/string

Specifies field visibility settings, like this; for example:

Code Block
languagejs
linenumberstrue
{ 
	"lud": "1", 
	"lumin": "1", 
	"lua": "1", 
	"lumax": "1", 
	"lbmin": "1", 
	"lbmax": "1", 
	"ldtc": "1", 
	"hu": "1", 
	"ft": "1"
}

where "1" indicates that a specific field is visible and ''0" indicates that it is not.

Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following:

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

(See this section for more field-specific information.)

orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

FieldTypeDescription
successbooleanIndicates whether your API request was successfully processed.
msgstringError message returned on failure.
fidinteger

Feature ID.

fnsstringFeature name.
ftypestringFeature type.
fvstringFeature version.
ludstring

Indicates period of time for which usage information is generated, ; i.e., date and time for hourly usage and dates for the remaining granularity options.

luminintegerMinimal licenses used count for a given date.
luafloatAverage licenses used count for a given date.
lumaxintegerMaximum licenses used count for a given date.
lbminintegerMinimal licenses borrowed count for a given date.
lbmaxintegerMaximum licenses borrowed count for given date.

ldtc

integerDenials count.
hufloatHours used.
ftintegerFeature total.
codeinteger

Error code if success equals false, null otherwise.

totalCountintegerTotal number of rows returned.

...

ParameterRequiredTypeDescription
${lsid}YesintegerLicense Server ID.
${returnType}YesstringSpecifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf.
sdYesstring Specifies the start date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-20.
edYesstring Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27.
granularityYesinteger Specifies granularity of the returned data, which can be one of the following:
  • Quarter - 2
  • Month - 3
  • Week - 4
  • Day - 5
  • Hour - 6
rnNostring Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.
filterNojson/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format. 

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

To filter by a numeric column, use the following format.

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


fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
{ 
	"lud": "1", 
	"lumin": "1", 
	"lua": "0", 
	"lumax": "1", 
	"lbmin": "1", 
	"lbmax": "1", 
	"ldtc": "1", 
	"hu": "0", 
	"ft": "0",
	"fns": "1",
	"fv": "1",
	"ftype": "1"
}

where "1" indicates that a specific field is visible, and ''0" indicates it is not.

Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointeger Specifies the offset of the first row to return.
orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following: 

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

(See this section for more field-specific information.)

orderDirectionNostring Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

FieldTypeDescription
successbooleanIndicates whether your API request was successfully processed.
msgstringError message returned on failure.
fidinteger

Feature ID.

fnsstringFeature name.
ftypestringFeature type.
fvstringFeature version.
ludstringIndicates period of time for which usage information is generated, ; i.e., date and time for hourly usage and dates for the remaining granularity options.
luminintegerMinimal licenses used count for given date.
luafloatAverage licenses used count for given date.
lumaxintegerMaximum licenses used count for given date.
lbminintegerMinimal licenses borrowed count for given date.
lbmaxintegerMaximum licenses borrowed count for given date.

ldtc

integerDenials count.
hufloatHours used.
ftintegerFeature total.
codeintegerError code if success equals false, null otherwise.
totalCountintegerTotal number of rows returned.

...