Page tree
Skip to end of metadata
Go to start of metadata

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}YesstringStandard format option. See Making an API request for details.
standard report options Novarious

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: 

ColumnFull nameTypeDescriptionVisible by default in export

ucd

DatedateThe date. Yes

uct

Total Usersinteger

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 Usersinteger

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 UsersintegerNumber of unique users that were denied a license during the given day.
Yes

ucch

Concurrent HostsintegerMaximum 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.

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