Denials API

The Denials endpoint delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch license usage metrics specific to Denials, allowing you to see exactly how many license checkout requests were denied and how often the denials took place.

Obtaining information about checkout denials

If you want to fetch metrics about the username and hostname for each denial, we recommend that you use the following URL request template.

GET /api/v1/report/feature/${featureId}/denials/${returnType}?sd=${startDate}&ed=${endDate}&(additional parameters, as needed) 

where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters are as follows:

{"un": "1", "hn": "1", "ldt": "1", "ldtc":"1"}

[
	{ 
		"type": "string",
		"field": "${un | hn | ldt}",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "ldtc",
		"value": "${value}" 
	}
]

 un, hn, ldt, ldt

The following code block shows an example result of a successful request:

  {
      success: ${success},
      msg: ${message},
      data: [{
        "un": ${userName},
        "hn": ${hostName},
        "ldt": ${licenseDenialTime},
        "ldtc": ${licenseDenialTotalCount}
      }],
	  "code": ${errorCode},
	  "totalCount": ${totalCount}
  }

where the response fields can be explained as follows:

Example 1

Say you would like to view denials for feature 3 over some period of time. To generate such data, enter a command similar to the following:

curl --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Example 2

Let's assume you want to see all denials for feature 3 ordered by username over a specific period of time. To do this, enter a command similar to this one:

curl --data "orderBy=un" --data "orderDirection=ASC" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Example 3

Say you're interested in viewing the first 100 denials for feature 3 over a specific period of time. To do this, enter a command that is similar to the following:

curl --data "limit=100" --data "offset=0" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Keep in mind that you can also put parameters directly into the URL, e.g. to generate data for the above example, the command would look like this:

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json?limit=100&offset=0&sd=2014-12-01&ed=2015-01-02"

Obtaining information about grouped checkout denials 

If you want to retrieve information about denials for username and hostname, we recommend that you use the following URL request template. 

GET /api/v1/report/feature/${featureId}/denials/grouped/${returnType}?sd=${startDate}&ed=${endDate}&grat=${granularity}&(additional parameters, as needed) 

where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters are as follows:

{"ldt": "1", "ldtc":"1"}

[
	{ 
		"type": "string",
		"field": "ldt",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "ldtc",
		"value": "${value}" 
	}
]

un, hn, ldt, ldt

The following code block shows an example result of a successful request:

  {
      success: ${success},
      msg: ${message},
      data: [{
        "ldt": ${licenseDenialTime},
        "ldtc": ${licenseDenialTotalCount}
      }]
  }

where the response fields can be explained as follows:

Example 1

Say you would like to view denials for feature 3 grouped by month. To generate such data, enter a command similar to this one:

curl --data "sd=2015-01-01" --data "ed=2015-01-02" --data "grat=3" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Example 2

Let's assume you want to see all denials for feature 3, grouped by quarter, ordered by total denial count from highest to lowest. To do this, enter a command similar to the following:

curl --data "orderBy=ldtc" --data "orderDirection=DESC" --data "sd=2014-01-01" --data "ed=2015-01-01" --data "grat=2" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Example 3

Let's say you're interested in viewing the first 100 denials for feature 3 over a specific period of time, grouped by hour. To do this, enter a command that is similar to the following:

curl --data "limit=100" --data "offset=0" --data "sd=2013-01-01" --data "ed=2015-01-02" --data "grat=6" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Please keep in mind that you can also put parameters directly into the URL, e.g. to generate data for the above example, the command would look like this:

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json?limit=5&offset=2&sd=2013-01-01&ed=2015-01-02&grat=6"