Page History

...

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

Parameter	Required	Type	Description
${returnType}	Yes	string

Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xlsx, or pdf.
fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block

language	js
firstline	1
linenumbers	true

{"ucd": "1", "uct": "1", "ucdy": "1", "ucde": "1", "ucch": "1"}

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

rn

NostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. 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 XLSX types. If provided, it cannot be left empty.filterNojson/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": "ucd",
		"value": "${value}"
	}
]

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

Code Block

firstline	1
linenumbers	true

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${uct | ucdy | ucde | ucch}",
        "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:

 ucd, uct, ucdy, ucde, ucch

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

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

Response

...

Code Block

firstline	1
linenumbers	true

{
    success: ${success},
    msg: ${message},
    data: [{
        "ucd": ${date},
        "uct": ${totalUsers},
        "ucdy": ${dailyUsers},
        "ucde": ${deniedUsers},
        "ucch": ${consurrentHosts}
    }],
    "code": ${errorCode},
    "totalCount": ${totalNumberOfRecords}
}

...

ucd

...

uct

...

ucdy

...

ucde

...

ucch

...

msg

...

success

...

Standard format option. See Making an API request for details.
standard report options	No	various	See Making an API request for details.

Response

On success, this report will contain one row for each day in the past. Each row consists of columns:

Column	Full name	Type	Description	Visible by default in export
ucd	Date	date	The date.	Yes
uct	Total Users	integer	If using old licensing: The number of unique users that were using a license on any realtime license server in the last 14 days. If using new licensing: The number of unique users that were using a license or were denied a license on any license server in the past.	Yes
ucdy	Daily Users	integer	If using old licensing: The number of unique users using a license on any realtime license server on the given day. If using new licensing: The number of unique users using a license or that were denied a license on any license server on the given day.	Yes
ucde	Denial Users	integer	Number of unique users that were denied a license during the given day.	Yes
ucch	Concurrent Hosts	integer	Maximum number of hosts that were concurrently active on the given day.	Yes

Note that the order in the table is the default order of the columns in the exported file

...

.

Example

The following example shows a command that downloads data about realtime users count to an XLSX file.

...

Page tree

Versions Compared

Old Version 31

New Version 32

Key

Example