...
If you want to retrieve information about usage history for a single feature, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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
...
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. | ||||||||||
granularity | Yes | integer | Specifies granularity of the returned data and can be one of the following:
| ||||||||||
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. | ||||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter by string column, use the following format:
To filter by numeric column, use the following format:
| ||||||||||
fieldsVisibility | No | json/string | Specifies field visibility settings, like this:
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: lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft | ||||||||||
orderDirection | No | string | Determines whether the sorting results order. Can be one of the following: ASC, DESCwill be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
...
Parameter | Required | Type | Description |
---|---|---|---|
featureIds | Yes | array | Arrays of feature ids IDs in the following format: id1, id2, id3... for example fi=1,2,3,5. |
sd | Yes | string | See Obtaining information about usage history for feature, above. |
ed | Yes | string | See Obtaining information about usage history for feature, above. |
granularity | Yes | integer | See Obtaining information about usage history for feature , above. |
...