Page History

The Usage Per User endpoint delivers license usage metrics specific to the Usage Per User report for selected types of aggregation (username, hostname, username and hostname, usergroup, hostgroup) , over a given timeframetime period.

Obtaining information about usage per user for a feature

Anchor
obtain obtain

You can easily fetch metrics about usage per user for a single feature by sending one of the following HTTP requestrequests.

 GET /api/v1/report/feature/${featureId}/usage-per-user/${returnType}?sd=${startDate=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed)

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

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

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

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${musage | hu | mu | hb | mb}",
		"value": "${value}" 
	}
]

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

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

Response

...

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{      		
			"fid": ${featureId},      		
			"lsid": ${licenseServerId},	
			"uid": ${userId},
			"uil": ${userIsLdap},
      		"fud": ${date},      					
			"un": ${username},      			
			"ugn": ${userGroupName},      		
			"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}
}

...

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.

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 Username(1) and Username and hostname(3). Otherwise, a semicolon-separated list of user IDs.	Unavailable
un	Username	string	Name of the user for aggregations Username(1) and Username and hostname(3). Otherwise, a semicolon-separated list of usernames.	Yes
uil	User is from LDAP	string

...

.. This field is returned only when the requested aggregation type was usergroup.Hostname or hostnames, depending on aggregation type. This field is returned only when requested aggregation type was hostgroup.

Field	Type	Description
success	boolean	Indicates whether 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 about whether the 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 the aggregation type.
for aggregations Username(1) and Username and hostname(3). Otherwise, a null value.	Unavailable
ugn	User Group	ugn	string	Name of user group	for aggregations Usergroup(4). Otherwise, an empty string.	Only for aggregation Usergroup(4)
hn	Hostname	string	Hostname for aggregations Hostname(2) and Username and hostname(3). Otherwise, a	hn	string	semicolon-separated list of	hostnames.	Yes
hgn	Host Group	string	Name of host group
lsn	string	License server name.
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 Namefns	string	Feature name.	Yes
fv	Feature Version	string	Feature version.	Yes
ftype	string	Feature type.	Feature Type	enumeration	See feature type descriptions for details.	Yes
musage	Max Usage	musage	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.
mu	integer	Maximum licenses used count for given date.
hb	float	Hours borrowed.
mb	integer	Maximum licenses borrowed count for a given date.
code	integer	Error code if success equals false, null otherwise.
totalCount	integer	Total number of rows returned.

Obtaining information about usage per user for a license server

You can easily fetch metrics about usage per user for a single license server by sending the following HTTP request.

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

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

...

ID of a single license server or "all" if information about all license servers is requested.

...

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

• QUARTER or 2
• MONTH or 3
• WEEK or 4
• DAY or 5

Note: Hourly (HOUR or 6) granularity is not supported by Usage Per User API.

...

Specifies aggregation type of the returned data. Aggregation type 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 XLSX. For CSV and JSON formats this parameter will be ignored.
Note: If you don't pass this parameter, it will be generated automatically for PDF and XLSX types. If provided, it cannot be left empty.

...

...

...

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

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

If orderBy is provided, orderDirection is mandatory.

...

Cumulative time used by all licenses of the feature in the period, in hours.	Yes
mu	Max Used	integer	Maximum number of licenses of the feature used in the period.	Yes
hb	Hours Borrowed	float	Cumulative time of all license borrows of the feature in the period, in hours.	Yes
mb	Max Borrowed	integer	Maximum number of licenses of the feature borrowed in the period.	Yes

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

...

.