Versions Compared

Old Version 1

changes.mady.by.user Unknown User (jkubala)

Saved on

compared with

New Version 2

changes.mady.by.user Unknown User (jkubala)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

License Statistics API allows you to generate data from the Usage HistoryPer User report. This report shows statistics for license usage by users, during any period that usage was tracked.

...

Code Block
languagejs
firstline1
linenumberstrue
 GET /api/v1/report/usage-history/feature/${featureId}/usage-per-user/${returnType}?sd=${startDate}&ed=${endDate}&granularitygrat=${granularity}$(additional parameters, as needed)

...

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 in YYYY-MM-DD format; for example, 2017-01-20.
edYesstringSpecifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27.
granularitygratYesinteger

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

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

Specifies the name 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. For CSV and JSON formats this parameter will be ignored.
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 string column, use the following format: 

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

To filter by numeric column, use the following format:

Code Block
languagejs
[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${luminfud | un | hn | lsn | fns | luafv | lumaxftype | lbminmusage | lbmaxhu | ldtcmu | huhb | ftmb}",
		"value": "${value}" 
	}
]


fieldsVisibilityNojson/string

Specifies field visibility settings, like this:

Code Block
languagejs
{ 
	"fud": "1", 
	"ludun": "1", 
	"luminhn": "1", 
	"lualsn": "1", 
	"lumaxfns": "1", 
	"lbminfv": "1", 
	"lbmaxftype": "1", 
	"ldtcmusage": "1", 
	"hu": "1", 
	"ft"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.

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
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...