Warning |
---|
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
The Realtime Users Count endpoint delivers license usage metrics specific to the Realtime Users Count report, allowing you to see detailed information about the License Statistics API allows you to generate data from the Realtime Users Count report. This report shows user count for all realtime license servers.
Obtaining information about realtime user count
If you want to retrieve information You can easily fetch metrics about realtime user count , we recommend that you send by sending the following HTTP request.
Code Block | linenumbers | true
---|
GET /api/v1/report/users/realtime-count/json${returnType} |
where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows:described below.
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
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 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. | filter | No | json/string |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "ucd",
"value": "${value}"
}
] |
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${uct | ucdy | ucde | ucch}",
"value": "${value}"
}
] |
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:
...
ucd
...
uct
...
ucdy
...
ucde
...
ucch
...
msg
...
success
...
${returnType} | Yes | string | 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 Licensing Model 2013: The number of unique users that were using a license on any realtime license server in the last 14 days. If using Licensing Model 2019: 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 Licensing Model 2013: The number of unique users using a license on any realtime license server on the given day. If using Licensing Model 2019: 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.
Code Block |
---|
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/users/realtime-count/XLSX" |
...