Page History

The Usage Per User endpoint delivers license usage metrics specific to the Usage Per User report for selected types of aggregation (user, host, user and host, usergroup, hostgroup) over a given time periodLicense 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 a feature

Anchor
obtain obtain

If you want to retrieve information You can easily fetch metrics about usage per user for a single feature, we recommend that you use the following URL request templateby sending one of the following HTTP requests.

 GET /api/v1/report/feature/${featureId}/usage-per-user/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&grat=${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 follows:

...

Specifies feature-specific parameters.

...

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

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

...

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

...

No

...

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.

...

Applies filtering license usage data on all fields.

...

...

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

To filter by numeric column, use the following format:

[
	{ 
		"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", 
	"mb": "1"
}

...

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

If orderBy is provided, orderDirection is mandatory.

...

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

{
	"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.

...

Obtaining information about usage per user for license server

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

 GET /api/v1/report/license-server/${licenseServerId}/usage-per-user/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed)

where  - $ $ indicates a variable value that you can replace with a proper value, according to your needs
 - value that best suits your needs. The possible parameters are as follows:described below.

[
	{ 
		"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", 
	"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},      		
			"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:

Response

On success, this report will contain one row for each feature for each aggregator for each period. Each row consists of the following columns.

FieldTypeDescriptionsuccessbooleanIndicates that your API request was successfully processed.msgstringError message returned on failure.fidintegerFeature ID.lsidintegerLicense server ID.uidintegerUser ID.uilbooleanInformation if user is managed by LDAP.fudstring

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.

unstringUsername.hnstringHostname.lsnstringLicense server name.
fnsstringFeature name.
fvstringFeature version.ftypestringFeature type.musage

Column	Full name	Type	Description	Visible by default in export
fud	Date	string	The time period. Format depends on granularity.	Yes
uid	User ID	string	Internal License Statistics identification of the user for aggregations User(1) and User and Host(3). Otherwise, a semicolon-separated list of user IDs.	Unavailable
un	User	string	Name of the user for aggregations User(1) and User and host(3). Otherwise, a semicolon-separated list of usernames.	Yes
uil	User is from LDAP	string	Information about whether the user is managed by LDAP for aggregations User(1) and User and host(3). Otherwise, a null value.	Unavailable
ugn	User Group	string	Name of user group for aggregations Usergroup(4). Otherwise, an empty string.	Only for aggregation Usergroup(4)
hn	Host	string	Hostname for aggregations Host(2) and User and host(3). Otherwise, a semicolon-separated list of hostnames.	Yes
hgn	Host Group	string	Name of host group for aggregations Hostgroup(5). Otherwise, an empty string.	Only for aggregation Hostgroup(4)
lsid	License Server ID	integer	Internal License Statistics identification of the license server hosting the feature.	Unavailable
lsn	License Server	string	Name of the license server hosting the feature.	Yes
fid	Feature ID	integer	Internal License Statistics identification of the feature.	Unavailable
fns	Feature Name	string	Feature name.	Yes
fv	Feature Version	string	Feature version.	Yes
ftype	Feature Type	enumeration	See feature type descriptions for details.	Yes
musage	Max Usage

float

Maximum usage of licenses in relation to total

license

number of licenses in the period, expressed in percentages.	Yes
hu	Hours Used	float

Hours used.

Cumulative time used by all licenses of the feature in the period, in hours.	Yes
mu	Max Used

mu

integer

Maximum number of licenses

used count for given date

of the feature used in the period.	Yes
hb	Hours Borrowed	float

Hours borrowed.

Cumulative time of all license borrows of the feature in the period, in hours.	Yes
mb	Max Borrowed

mb

integer

Maximum number of licenses

borrowed count for given date

of the feature borrowed in the period.

codeinteger

Error code if success equals false, null otherwise.

totalCountintegerTotal number of rows returned

Yes

Note that the order in the table is the default order of the columns in the exported file.