...
Parameter | Required | Type | Description |
---|---|---|---|
featureIds | Yes | array | Arrays of feature 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, aboveSpecifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. |
ed | Yes | string | See Obtaining information about usage history for feature, aboveSpecifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. |
granularity | Yes | integerSee Obtaining information about usage history for feature , above. | Specifies granularity of the returned data, which can be one of the following:
|
Currently the report is only returned only in JSON syntax. There are plans to introduce CSV, XLS and PDF formats in the future.
...
Parameter | Required | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${lsid} | Yes | integer | License Server ID. | ||||||||||
${returnType} | Yes | string | See Obtaining information about usage history for feature, aboveSpecifies 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 | See Obtaining information about usage history for feature, above Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. | ||||||||||
ed | Yes | string | See Obtaining information about usage history for feature, above 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, which 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. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty | See Obtaining information about usage history for feature, above. | rn | No | string | See Obtaining information about usage history for feature, above. | |||||
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, for example:
where "1" indicates that a specific field is visible, ''0" indicates 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 | See Obtaining information about usage history for feature, above Determines the maximum number of data records that can be returned. The value must be greater than zero. | ||||||||||
offset | No | integer | See Obtaining information about usage history for feature, above 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 | fns | fv | ftype | fid | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft | ||||||||||
orderDirection | No | string | See Obtaining information about usage history for feature, above Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
...