License Statistics API lets allows you to generate data from the Expiring Features report. This report shows statistics for features expiring in the futureabout features that are nearing expiration.
Obtaining information about expiring features
If you want to retrieve information about expiring features that are nearing expiration, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/${licenseServerId}/json?sd=${startDate}&ed=${endDate}$(additional parameters, as needed) |
where
- $ indicates a variable value that you can replace with an appropriate a proper value, as neededaccording to your needs
- the possible parameters are as follows:
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${licenseServerId} | Yes | integer/string | Specifies id ID of license server for which we want to gather data about feature expirations. It can also be set 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 YYYY-MM-DD format; for example, 2017-01-20. If not provided, it defaults to today | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. If not 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 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. | ||||||||||||||||||
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 | ||||||||||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "success": ${success}, "msg": ${message}, "data": [ { "fid": ${featureId}, "fns": ${featureName}, "ftype": ${featureType}, "fv": ${featureVersion}, "fexp": ${featureExpires}, "lsid": ${licenseServerId}, "lsn": ${licenseServerName}, "vn": ${licenseServerVendorName}, } ], "code": ${code}, "totalCount": ${count} } |
...
where the response fields can be explained as follows:
Field | Type | Description |
---|---|---|
success | boolean | Indicates that your API request was successfully processed. |
msg | string | Error message returned on failure. |
fid | integer | Feature ID. |
fns | string | Feature Namename. |
ftype | string | Feature Typetype. |
fv | string | Feature Versionversion. |
fexp | string | Feature Expires (feature expiration date). |
lsid | integer | License Server Idserver ID. |
lsn | string | License Server Nameserver name. |
vn | string | License Server Vendor Nameserver vendor name. |
code | integer | Error code if success equals false, null otherwise. |
totalCount | integer | Total number of rows that will be returned. |
Example 1
For example, say Say you would like to view all features expiring in the next 12 months on all of you license servers. To generate such data, enter a command that is similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/json" |
Example 2
For example, say you would like to To view all features expiring in some period of time on one of your license servers that have licenseServerId=1. To generate such data, enter a command that is command similar to the followingthis one:
Code Block | ||
---|---|---|
| ||
curl --data "sd=2015-01-01" --data "ed=2015-03-01" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/json" |
Obtaining information about expiring features amounts in some period of time
If you want to retrieve information about how many features expires expire in some period of time, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/{licenseServerId}/count/grouped/json?sd=${startDate}&ed=${endDate}&granularity=${granularity}&filter=${filter} |
Parameters where the possible parameters are as follows:
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
licenseServerId | Yes | array | Arrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5. | ||||||||||||||||||
sd | No | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. If not provided defaults to today. | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. If not provided defaults to [today + 12 months] | ||||||||||||||||||
granularity | No | integer | Specifies granularity of the returned data, which and can be one of the following (defaults to Month):
By default, this parameter is set to "Month". | ||||||||||||||||||
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:
|
If your request is successful, you should see a response similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "success": ${success}, "msg": ${message}, "data": [ { "fexpy": ${featureId}, "fexpm": ${featureName}, "fexpc": ${featureVersion}, "granularity": ${granularity} } ], "code": ${code}, "totalCount": ${count} } |
...
Field | Type | Description |
---|---|---|
success | boolean | Indicates that your API request was successfully processed. |
msg | string | Error message returned on failure. |
fexpy | integer | Year |
fexpm | integer | Number of period |
fexpc | integer | Count of expiring features in period |
granularity | integer | Period granularity:
|
code | integer | Error code if success equals false, null otherwise. |
totalCount | integer | Total number of rows returned. |
...