The Realtime Users Count endpoint delivers license usage metrics specific to the Realtime Users Count report, allowing you to see detailed information about the user count for all realtime license servers.
Obtaining information about realtime user count
You can easily fetch metrics about realtime user count by sending the following HTTP request.
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. 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. |
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example: {"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 | No | string | Specifies 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. |
| filter | No | json/string | Applies filtering license usage data on all fields. To filter by a string column, use the following format. [
{
"type": "string",
"field": "ucd",
"value": "${value}"
}
]
To filter by a numeric column, use the following format. [
{
"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 (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. |
Response
The following code block shows an example result of a successful request.
{
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 returned in YYYY-MM-DD format; for example, 2017-05-20. |
uct | integer | Total number of users specified in the license. |
ucdy | integer | Number of daily users using a license on a particular date. |
ucde | integer | Number of all users that were denied a license. |
ucch | integer | Number of hosts that were concurrently active on a particular date. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether your API request was successfully processed. |
| code | integer | Error code for unsuccessful request. |
| totalCount | integer | Total number of rows. |
Example
The following example shows a command that downloads data about realtime users count to an XLSX file.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/users/realtime-count/XLSX"