...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| 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. 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 | 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. | ||||||||||||||
| 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. |
Response
The following code block shows an example result of a successful request.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
Where where the response fields can be explained as follows.Anchor fields def fields def
...
| 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, xls, 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 | integer | 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.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId_1},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
},
{
"fid": ${featureId_2},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
where the response fields can be explained as follows.Anchor fields def fields def
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether your API request was successfully processed. |
| msg | string | Error message returned on failure. |
| fid | integer | Feature ID. |
| fns | string | Feature name. |
| ftype | string | Feature type. |
| fv | string | Feature version. |
| lud | string | Indicates period of time for which usage information is generated; i.e., date and time for hourly usage and dates for the remaining granularity options. |
| lumin | integer | Minimal licenses used count for a given date. |
| lua | float | Average licenses used count for a given date. |
| lumax | integer | Maximum licenses used count for a given date. |
| lbmin | integer | Minimal licenses borrowed count for a given date. |
| lbmax | integer | Maximum licenses borrowed count for given date. |
ldtc | integer | Denials count. |
| hu | float | Hours used. |
| ft | integer | Feature total. |
| code | integer | Error code if success equals false, null otherwise. |
| totalCount | integer | Total number of rows returned. |
...
There is also another, already deprecated, endpoint that allows you to do just thatfetch such metrics:
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/usage-history/license-server/${lsid}/${returnType}?sd=${startDate}&ed={endDate}&granularity=${granularity}$(additional parameters, as needed) |
...
| Parameter | Required | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${lsid} | Yes | integer | License Server ID. | ||||||||||||||
| ${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. 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 | 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. | ||||||||||||||
| 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 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 | fns | fv | ftype | fid | 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. |
Response
The following code block shows an example result of a successful request.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId_1},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
},
{
"fid": ${featureId_1},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion}
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
...
| Code Block |
|---|
GET /api/v1/report/license-server-group/${lsgid}/usage-history/${returnType}?sd=${startDate}&ed={endDate}&granularity=${granularity}$(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${lsgid} | Yes | integer | ID of the license server group. |
...