Page History

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

You can easily fetch metrics about list the username and hostname for each denial by calling this HTTP GET request:that took place by sending the following HTTP request.

Code Block

language	js
firstline	1	linenumbers	true

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

...

Field	Type	Description
un	string	Username.
hn	string	Hostname.
ldt	string	Date on which the denial took place in YYYY-MM-DD format.
ldtc	string	Total number of denied license checkout requests.
msg	string	Error message returned on failure.
success	boolean	Indicates whether the your API request was successfully processed.
code	integer	Error code for unsuccessful request.
totalCount	integer	Total number of all matching results.

Example 1

Say you would like to view obtain information about denials for feature "3 over some period of time" over a given timeframe. To generate such this data set, enter a command similar to the following:.

Code Block

language	js
firstline	1
linenumbers	true

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 obtain information about all denials for feature "3" ordered by username over a specific period of timetimeframe. To do thisgenerate such data set, enter a command similar to this one:the following.

Code Block

language	js
firstline	1
linenumbers	true

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"

...

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

Code Block

language	js
firstline	1
linenumbers	true

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 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:
you'll need to enter will be similar to the following.

Code Blockcode

language	js
firstline	1
linenumbers	true

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 fetch metrics about list denials for username and hostname by calling this sending the following HTTP GET request:.

Code Block

language	js
firstline	1
linenumbers	true

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

...

Parameter

Required

Type

Description

${featureId}

Yes

integer

Specifies ID of the feature for which you want to view grouped checkout denials.

${returnType}

Yes

string

Specifies format in which the data should be returned. The format can be one of the following: JSONjson, CSVcsv, XLS xls or PDFpdf.

sd

Yes

string

Specifies starting date from which you want to generate the report. The date format is in YYYY-MM-DD format; for example, 2017-05-20.

ed

Yes

string

Specifies end date from which you want to generate the report. The date format is in YYYY-MM-DD format; for example, 2017-05-20. The date is inclusive, meaning that all data from a particular day will be included in the report.

grat

Yes

integer

Specifies granularity of the returned data, and can be one of the following:

Quarter - 2
Month - 3
Week - 4
Day - 5
Hour - 6

fieldsVisibility

No

json/string

Specifies field visibility settings, for example:

Code Block

language	js
firstline	1
linenumbers	true

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

where number "1" indicates that a specific field is visible.
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.

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.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.

filter

No

json/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format:

Code Block

language	js
firstline	1
linenumbers	true

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

To filter by a numeric column, use the following format:

Code Block

language	js
firstline	1

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

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:

un, hn, ldt, ldt

(See this section for more field-specific information.)

orderDirection

No

string

Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

Example 1

Say you would like to view obtain information about denials for feature "3" grouped by month. To generate such data set, enter a command similar to this one:the following.

Code Block

language	js
firstline	1
linenumbers	true

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"

...

Let's assume you want to see all denials grouped by quarter for feature "3, grouped by quarter, ". In addition, you want to obtain data that is ordered by the total denial count from highest to lowest. To do thisgenerate such data set, enter a command similar to the following:.

Code Block

language	js
firstline	1
linenumbers	true

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"

...

Let's say you're interested in viewing the first 100 denials for feature "3" over a specific period of time, timeframe. In addition, you want to obtain data that is grouped by hour. To do thisTo generate such data set, enter a command that is similar to the following:.

Code Block

language	js
firstline	1
linenumbers	true

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"

...

Page tree

Versions Compared

Old Version 55

New Version 56

Key

Obtaining information about checkout denials

Obtaining information about grouped checkout denials