Versions Compared

Old Version 23

changes.mady.by.user Szczepan Lach

Saved on

compared with

New Version 24

changes.mady.by.user Szczepan Lach

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

License Statistics API lets you generate data from the Denials report. This report shows how many license checkout requests were denied and how often the denials took place.

...

Obtaining information about checkout denials

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

...

ParameterRequiredTypeDescription
${featureId}Yesinteger

Specifies feature-specific parameters.

${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.
sdYesstringSpecifies starting date from which you want to generate the report. The date and time format is as follows: YYYY-MM-DD, for example, 2015-01-20.
ed

Yes

stringSpecifies end date from which you want to generate the report. Date format as above. Date is inclusive, meaning all data from the particular day will be included in the report.
fieldsVisibility Nojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"un": "1", "hn": "1", "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.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or Excel.
filterNojson/string

 

Applies filtering denials license usage data on all fields.

To filter your databy string column, use the following format:

Code Block
languagejs
firstline1
linenumberstrue
[
	{ 
		"valuetype": intOrString, "string",
		"field": "${un | hn | ldt}",
		"value": "${value}"
	}
]
To filter by numeric column, use the following format:
 
Code Block
languagejs
firstline1
[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${ldtc}",
		"value": "${value}" 
	}
]
limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following: un, hn, ldt, ldtc.

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

...

Code Block
languagejs
firstline1
linenumberstrue
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/denials/3/json"

Example 3

Let's assume 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:

Code Block
languagejs
firstline1
linenumberstrue
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/denials/3/json"

Sample script

???

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.

 

Code Block
languagejs
firstline1
linenumberstrue
GET /api/v1/report/denials/grouped/${featureId}/${returnType}?sd=${startDate}&ed=${endDate}&(additional parameters, as needed) 

 

where:

 

- $ indicates a variable value that you can replace with an appropriate value, as needed

 

- possible parameters are as follows:

 

ParameterRequiredTypeDescription
${featureId}Yesinteger

Specifies feature-specific parameters.

${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.
sdYesstringSpecifies starting date from which you want to generate the report. The date and time format is as follows: YYYY-MM-DD, for example, 2015-01-20.
ed

Yes

stringSpecifies end date from which you want to generate the report. Date format as above. Date is inclusive, meaning all data from the particular day will be included in the report.
granularityYesinteger  Specifies granularity of the returned data, which can be one of the following:
 
  • Quarter - 2
  • Month - 3
  • Week - 4
  • Day - 5
  • Hour - 6
fieldsVisibility Nojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"un": "1", "hn": "1", "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.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or Excel.
filterNojson/string

Applies filtering denials data on all fields. To filter your data, use the following format:

Code Block
languagejs
firstline1
linenumberstrue
[{"value": intOrString, "field": "${un | hn | ldt | ldtc}"}]
limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following: un, hn, ldt, ldtc.

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

 

If your request is successful, you should see a response similar to the following: