Page History

...

Parameter

Required

Type

Description

fieldsVisibility

No

json/string

rn

No

string

filter

No

json/string

Applies filtering license usage data on all fields.

To filter by string column, use the following format:

Code Block

language	js

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

To filter by numeric column, use the following format:

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

orderDirection

No

string

Determines 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:

Code Block

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

where the response fields can be explained as follows:

Field	Type	Description
ucd	string	Date in YYYY-MM-DD format.
uct	integer	Total Users.
ucdy	integer	Daily Users.
ucde	integer	Denied Users.
ucch	integer	Concurrent Hosts.
msg	string	Error message returned on failure.
success	boolean	Indicates if the API request was successfully processed.
code	integer	Error code if success == false.
totalCount	integer	Total number of records.

Page tree

Versions Compared

Old Version 4

New Version 5

Key