...
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, xlsx, or pdf. | ||||||||||||||
sd | Yes | string | Specifies the start date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-20. | ||||||||||||||
ed | Yes | string | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27. | ||||||||||||||
granularity | Yes | integerstring | 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 XLSX. 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 a string column, use the following format.
To filter by a 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 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 (See this section for more field-specific information.) | ||||||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
Parameter | Required | Type | Description |
---|---|---|---|
${returnType} | Yes | string | Specifies the format in which usage history comparison data will be returned. The format can be one of the following: json, csv, xlsx, or pdf. |
featureIds | Yes | array | Arrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5. |
sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-20. |
ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-27. |
granularity | Yes | integerstring | Specifies granularity of the returned data, which can be one of the following:
|
Response
The following code block shows an example result of a successful request.
...