...
Obtaining information about expiring features
If you want to fetch metrics about You can easily list features that are nearing expiration , use the following URL request template.by calling this HTTP GET request:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/${licenseServerId}/json?sd=${startDate}&ed=${endDate}$(additional parameters, as needed) |
...
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${licenseServerId} | Yes | integer/string | Specifies ID of license server for which we want to gather data about features nearing expiration. You can set this parameter to 'all' to gather data from all license servers. | ||||||||||||||||||
${returnType} | Yes | string | Specifies the format in which license data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf. | ||||||||||||||||||
sd | No | string | Specifies the start date for which the report will be generated in . The date format is YYYY-MM-DD format; for example, 2017-05-20. If neither this field, nor "ed" is provided, it defaults to today. | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated in . The date format is YYYY-MM-DD format; for example, 2017-05-27. If neither this field, nor "sd" is provided, it defaults to [today + 12 months]. | ||||||||||||||||||
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, 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, like this:
where "1" indicates that a specific field is visible and ''0" indicates that it is not. | ||||||||||||||||||
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: fid | fns | fv | ftype | vn | lsn | fexp (See this section for more field-specific information.) | ||||||||||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or descending (DESC) order. |
...
Obtaining information about the number of features expiring in some period of time
If you want to fetch metrics about how many features You can easily list features that are going to expire in some period of time , use the following URL request template. by calling this HTTP GET request:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/{licenseServerId}/count/grouped/json?sd=${startDate}&ed=${endDate}&granularity=${granularity}&filter=${filter} |
...
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
licenseServerId | Yes | integer/string | ID of the license server or 'all' string for all license servers. | ||||||||||||||||||
sd | No | string | Specifies the start date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-01-20. If neither this field, nor "ed" is provided, it defaults to today. | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-01-27. If neither this field, nor "sd" is provided, it defaults to [today + 12 months]. | ||||||||||||||||||
granularity | No | integer | Specifies granularity of the returned data, and can be one of the following:
By default, this parameter is set to show monthly statistics. | ||||||||||||||||||
filter | No | 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:
|
...