Usage History for Feature
If you want to obtain information about usage history for single feature, you have to use following URL request template.
GET /api/v1/report/usage-history/feature/${featureId}/${returnType}?sd=${startDate}&ed={endDate}&granularity=${granularity}$(additional parameters, as needed)
where:
- $ indicates a variable value that you can replace with an appropriate value, as needed
- the possible parameters are as follows:
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. |
| ${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. |
| sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20. |
| ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27. |
| granularity | Yes | integer | Specifies granularity of the returned data; Can be one of the following:
|
| filter | No | json/string | |
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example: {"lud": "1", "lumin": "1", "lua": "1", "lumax": "1", "lbmin": "1", "lbmax": "1", "ldtc": "1", "hu": "1", "ft": "1"}
where number "1" indicates that a specific field is visible. 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: lud, lumin, lua, lumax, lbmin, lbmax, ldtc, hu, ft |
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |