Denials API

The Denials endpoint delivers 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

You can easily list the username and hostname for each denial that took place by sending the following HTTP request.

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. The possible parameters are described below.

{"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

Response

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

The following example shows a command that lets you obtain information about denials for feature "3" over a given time period.

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

The following example shows a command that lets you obtain information about all denials for feature "3" over a specific time period, with data ordered by username.

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

The following example shows a command that lets you view the first 100 denials for feature "3" over a given time period.

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"

You can also put parameters directly into the URL; for the above example, the command would be similar to the following.

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

You can easily list denials for username and hostname by sending the following HTTP request.

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. The possible parameters are described below.

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

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

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

un, hn, ldt, ldt

Response

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

The following example shows a command that obtains information about denials for feature "3" grouped by month.

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

The following example shows a command that lets you see all denials grouped by quarter for feature "3" ordered by the total denial count from highest to lowest.

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

The following example shows a command that lets you view the first 100 denials for feature "3" over a specific time period, grouped by hour. 

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"

You can also put parameters directly into the URL; for the above example, the command would look like the following:

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"