Versions Compared

Old Version 26

changes.mady.by.user Unknown User (mkos)

Saved on

compared with

New Version 27

changes.mady.by.user Tracy McCurdy

Saved on

Key

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

...

Code Block
GET /api/v1/report/users/realtime-count/${returnType}

where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.

ParameterRequiredTypeDescription
${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.
fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"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 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.
filterNojson/string

Applies filtering license usage data on all fields.

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

Code Block
languagejs
firstline1
linenumberstrue
[
	{ 
		"type": "string",
		"field": "ucd",
		"value": "${value}"
	}
]

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

 

Code Block
firstline1
linenumberstrue
[
    {
        "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.

...

FieldTypeDescription

ucd

stringDate returned in YYYY-MM-DD format; for example, 2017-05-20.

uct

integerTotal number of users specified in the license.

ucdy

integerNumber of daily users using a license on a particular date.

ucde

integerNumber of all users that were denied a license.

ucch

integerNumber of hosts that were concurrently active on a particular date.

msg

stringError message returned on failure.

success

booleanIndicates whether your API request was successfully processed. 
codeintegerError code for unsuccessful request.
totalCountintegerTotal number of rows.

Example

To download The following command downloads data about realtime users count in to an XLS file, enter a command similar to the following.

Code Block
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/users/realtime-count/xls"

...