Warning |
---|
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
License Statistics API lets you generate data from The Expiring Features endpoint delivers license usage metrics specific to This the Expiring Features report.report shows statistics for features expiring in the futurethat are nearing expiration.
Obtaining information about expiring features
If you want to retrieve information about expiring features, we recommend that you use the following URL request template.
You can easily list features that are nearing expiration by sending the following HTTP request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/${licenseServerId}/json${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}$(additional parameters, as needed) |
...
- $ where $ indicates a variable value that you can replace with an appropriate value, as needed
- possible parameters are as follows:
a value that best suits your needs. The possible parameters are described below.
Parameter | Required | Type | Description |
---|---|---|---|
${licenseServerId} | Yes | integer/string |
Internal License Statistics identification of the license server for which |
you 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 |
Standard format option. See Making an API request for details. | |
sd | No |
date |
Start date for which the report will be generated |
. If neither this field nor "ed" is provided, the date defaults to the current date. | |
ed | No |
date |
End date for which the report will be generated |
No
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.
Applies filtering license usage data on all fields.
To filter by string column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "string",
"field": "${fn | ft | fe | lsn | lsvn | fv}",
"value": "${value}"
}
] |
To filter by numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fig | lsid}",
"value": "${value}"
}
] |
Specifies field visibility settings, like this:
Code Block | ||
---|---|---|
| ||
{
"fn": "1",
"fv": "1",
"ft": "1",
"lsvn": "1",
"lsn": "1",
"fe": "1"
} |
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.
Specifies the field by which you want to order your data records. The field name can be one of the following:
fn | fv | ft | lsvn | lsn | fe
...
. If neither this field nor "sd" is provided, the date defaults to the current date + 12 months. | |||
standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
fid | Feature ID | integer | Internal License Statistics identification of the feature. | Yes |
fns | Feature Name | string | Feature name. | Yes |
fv | Feature Version | enumeration | Feature version. | Yes |
ftype | Feature Type | string | See feature type descriptions for details. | Yes |
vn | Vendor | string | Name of license server vendor hosting the feature. | Yes |
lsid | License Server ID | integer | Internal License Statistics identification of license server hosting the feature. | Yes |
lsn | License Server | string | Name of license server hosting the feature. | Yes |
fexp | Feature Expires | date | Day when the feature expires. | Yes |
Note that the order in the table is the default order of the columns in the exported file.
Example 1
The following example shows a command that obtains statistics about all features expiring in the next 12 months on all license servers.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/json" |
Example 2
The following example shows a command that obtains information about all features expiring in a specified period of time on a license server with an ID of "1."
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 the number of features expiring in some period of time
You can easily list features that are going to expire in some period of time by sending the following HTTP request:
...
Code Block | ||
---|---|---|
| ||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"fn": ${featureName},
"ft": ${featureType},
"fv": ${featureVersion},
"fe": ${featureExpires},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"lsvn": ${licenseServerVendorName},
}
],
"code": ${code},
"totalCount": ${count}
} |
where the response fields can be explained as follows:
...
Feature Name
...
lsvn
...
Error code if success equals false, null otherwise.
...
Obtaining information about expiring features amounts in some period of time
If you want to retrieve information about how many features expire in some period, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/expiry/server/{licenseServerId}/count/grouped/json?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&granularity=${granularity}&filter=${filter} |
Parameters are where the possible parameters can be explained as follows:
Parameter | Required | Type | Description |
---|---|---|---|
licenseServerId | Yes |
integer/string | Internal License Statistics identification of license server for which you want to gather data about features nearing expiration. You can set this parameter to 'all' to gather data from all license servers. |
sd | No |
date |
Start date for which the report will be generated |
.If neither this field nor "ed" is provided, the date defaults to the current date. | |
ed | No |
date |
End date for which the report will be generated |
. If neither this field nor "sd" is provided, the date defaults to the current date + 12 months. | |
granularity | No |
- Quarter - 2
- Month - 3
- Week - 4
- Day - 5
Applies filtering license usage data on all fields.
To filter by string column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "string",
"field": "${fn | ft | fe | lsn | lsvn | fv}",
"value": "${value}"
}
] |
To filter by numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fig | lsid}",
"value": "${value}"
}
] |
...
enumeration | Period type the result is aggregated for. HOUR granularity is not supported. See granularity descriptions for further details. By default, this parameter is set to MONTH | ||
filter | No | JSON | See Making an API request for details. |
This report supports only JSON format.
This report supports filtering, but does not support other standard options (limiting or ordering).
Response
On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.
Column | Full name | Type | Description |
---|---|---|---|
fexpy | Year | integer | Year for which the time period number has been specified. |
fexpm | Period Number | integer | Number of time period such as day, week, month, etc. |
fexpc | Count | integer | Count of features expiring in the given period of time. |
granularity | Granularity | enumeration | Granularity given in parameter. Defaults to MONTH if unspecified. |
Example 1
The following example shows a command that obtains a count of features that will expire for every month in the next 12 months on all license servers.
Code Block | ||
---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/count/grouped/json" |
Example 2
The following example shows a command that obtains a count of features that will expire for every week in a specified period of time on a license server with an ID of "1."
Code Block | ||
---|---|---|
| ||
curl --data "sd=2015-01-01" --data "ed=2015-03-01" --data "granularity=4" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/count/grouped/json" |