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 on hosts, during any period that usage was tracked.

...

Parameter

Required

Type

Description

${featureId}

Yes

integer

Specifies feature-specific parameters.

${returnType}

Yes

string

Specifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf.

sd

Yes

string

Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20.

ed

Yes

string

Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27.

grat

Yes

integer

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

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

agrt

No

integer

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

Username - 1
Hostname - 2
Username and hostname - 3
Usergroup - 4
Hostgroup - 5

By default data is aggregated by username and hostname

rn

No

string

Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. 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 and XLS/XLSX types. If provided, it cannot be left empty.

filter

No

json/string

Applies filtering license usage data on all fields.

To filter by string column, use the following format:

Code Block

language	js

[
	{ 
		"type": "string",
		"field": "lud"${fud | un | ugn | hn | hgn | lsn | fns | fv | ftype}",
		"value": "${value}"
	}
]

To filter by numeric column, use the following format:

Code Block

language	js

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${fud | un | hn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb}",
		"value": "${value}" 
	}
]

fieldsVisibility

No

json/string

Specifies field visibility settings, like this:

Code Block

language	js

{ 
	"fud": "1", 
	"un": "1", 
	"ugn": "1",
	"hn": "1", 
	"hgn": "1",
	"lsn": "1", 
	"fns": "1", 
	"fv": "1", 
	"ftype": "1", 
	"musage": "1", 
	"hu": "1", 
	"mu": "1", 
	"hb": "1", 
	"mb": "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.

limit

No

integer

Determines the maximum number of data records that can be returned. The value must be greater than zero.

offset

No

integer

Specifies the offset of the first row to return.

orderBy

No

string

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

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

If orderBy is provided, orderDirection is mandatory.

orderDirection

No

string

Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. If orderDirection is provided, orderBy is mandatory.

...

Code Block

language	js

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{      		
			"fid": ${featureId},      		
			"lsid": ${licenseServerId},	
			"uid": ${userId},
			"uil": ${userIsLdap},
      		"fud": ${date},      					
			"un": ${username},      			
			"hnugn": ${hostnameuserGroupName},
      		
			"hn": ${hostname},
			"hgn": ${hostGroupName},
			"lsn": ${licenseServerName},
      		"fns": ${featureName},
      		"fv": ${featureVersion},
      		"ftype": ${featureType},
      		"musage": ${maxUsage},
      		"hu": ${hoursUsed},
      		"mu": ${maxUsed},
      		"hb": ${hoursBorrowed},
      		"mb": ${maxBorrowed}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

...

Field	Type	Description
success	boolean	Indicates that your API request was successfully processed.
msg	string	Error message returned on failure.
fid	integer	Feature ID.
lsid	integer	License server ID.
uid	integer	User ID.
uil	boolean	Information if user is managed by LDAP.
fud	string	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.
un	string	Username or semicolon-separated list of usernames, depending on aggregation type.
ugn	string	Name of user group. Field is only returned when requested aggregation type was usergroup.
hn	string	Hostname or semicolon-separated list of hostnames, depending on aggregation type.
hgn	string	Name of host group. Field is only returned when requested aggregation type was hostgroup.
lsn	string	License server name.
fns	string	Feature name.
fv	string	Feature version.
ftype	string	Feature type.
musage	float	Maximum usage of licenses in relation to total license number, expressed in percentages.
hu	float	Hours used.
mu	integer	Maximum licenses used count for given date.
hb	float	Hours borrowed.
mb	integer	Maximum licenses borrowed count for given date.
code	integer	Error code if success equals false, null otherwise.
totalCount	integer	Total number of rows returned.

...

- possible parameters are as follows:

Parameter	Required	Type	Description
${licenseServerId}	Yes	integer/string	ID of single license server or "all" if information about all license servers is requested.
${returnType}	Yes	string	Specifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf.
sd	Yes	string	Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20.
ed	Yes	string	Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27.
grat	Yes	integer	Specifies granularity of the returned data, which can be one of the following: Quarter - 2 Month - 3 Week - 4 Day - 5 Hour - 6
agrt	No	integer	Specifies aggregation type of the returned data, which can be one of the following: Username - 1 Hostname - 2 Username and hostname - 3 Usergroup - 4 Hostgroup - 5 By default data is aggregated by username and hostname
rn	No	string	Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. 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/XLSX types. If provided, it cannot be left empty.
filter	No	json/string	Applies filtering license usage data on all fields. To filter by

string

any column

, use the following format:

Code Block

language	js

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

To filter by numeric column, use the following format:

Code Block

language	js

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${fud | un | hn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb}",
		"value": "${value}" 
	}
]

use format specified in previous section.
fieldsVisibility	No	json/string	Specifies field visibility settings

, like this:

Code Block

language	js

{ 
	"fud": "1", 
	"un": "1", 
	"hn": "1", 
	"lsn": "1", 
	"fns": "1", 
	"fv": "1", 
	"ftype": "1", 
	"musage": "1", 
	"hu": "1", 
	"mu": "1", 
	"hb": "1", 
	"mb": "1"
}

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

. In order to do so use format specified in previous section. 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.
limit	No	integer	Determines the maximum number of data records that can be returned. The value must be greater than zero.
offset	No	integer	Specifies the offset of the first row to return.
orderBy	No	string	Specifies the field by which you want to order your data records. The field name can be one of the

following:

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

specified in previous section.

If orderBy is provided, orderDirection is mandatory.

orderDirection

No

string

Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. If orderDirection is provided, orderBy is mandatory

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

Code Block

language	js

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{      		
			"fid": ${featureId},      		
			"lsid": ${licenseServerId},	
			"uid": ${userId},
			"uil": ${userIsLdap},
      		"fud": ${date},      		
			"un": ${username},      		
			"hn": ${hostname},
      		"lsn": ${licenseServerName},
      		"fns": ${featureName},
      		"fv": ${featureVersion},
      		"ftype": ${featureType},
      		"musage": ${maxUsage},
      		"hu": ${hoursUsed},
      		"mu": ${maxUsed},
      		"hb": ${hoursBorrowed},
      		"mb": ${maxBorrowed}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

where the response fields can be explained as follows:

...

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.

...

Error code if success equals false, null otherwise.

...

one specified in section for feature.

Page tree

Versions Compared

Old Version 5

New Version 6

Key