View Requests of Licenses in REST API (License Events)

Use LICENSE_EVENTS to view a device's most recent request to Aternity for a monitoring license, and if rejected, it displays the reason. Aternity automatically allocates license units whenever a device requests to report its performance. By default, Aternity reserves your manually allocated licenses, then automatically grants requests from any device type until it reaches the total licenses allowed. You can also limit the number of licenses for each type of device. For example, if you purchase 1000 license units, you can set a limit of up to 300 B2E mobile devices.

For example, you can check whether a specific device does not appear in the dashboards due to insufficient licenses, and then purchase more licenses if required.

Manually allocate a license, or allow Aternity to automatically allocate from the available licenses

Each entry from LICENSE_EVENTS returns a the last request from this device for a license, the type of license, and whether Aternity accepted or rejected the request with the reason.

Note

You can access data using this API (retention) going back up to 2 days. If you do not add a relative_time filter, by default it returns data for the past day.

Note

This article covers the latest REST API version. For older version 1.0, click here.

You can view this data and set limits for license units inside Aternity, and there you can also view these licensing events which list those granted or rejected (learn more).

License Provisioning page in Aternity

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view Aternity REST API, enter the base URL from Aternity > User icon > REST API Access, followed by the name of the API into a browser, Excel or PowerBI (learn more). For VIEWING, use <base_url>/latest/API_NAME; for INTEGRATIONS, use <base_url>/<version number>/API_NAME (for example, <base_url>/v1/API_NAME, or <base_url>/v1.0/API_NAME, or <base_url>/v2/API_NAME, or <base_url>/v2.0/API_NAME).

Get the latest REST API version for analyzing in the external app
:
Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Examples

To access this API from a browser, Excel or Power BI (learn more), enter <base_url>/latest/LICENSE_EVENTS or <base_url>/v2/LICENSE_EVENTS

If a device does not appear in Aternity's dashboards, you can check if Aternity granted a license to that device:

.../LICENSE_EVENTS?$select=license_event,license_owner,license_event_reason&$filter=license_owner eq 'hostname'

Supported Parameters

You can view the data by entering the URL into Excel, into a browser, or into or any OData compatible application such as Power BI.

You can add parameters to the URL to filter the returned data, by adding a question mark (?) followed by a parameter and value, such as .../API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../API_NAME?$format=xml&$top=5.

Query Options Description
$select=

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for testing the raw data in a web browser. For example: .../API_NAME?$format=xml

$orderby=

Use $orderby to sort the returned data according to the value you choose. For example, .../API_NAME?$orderby=LOCATION

$top=

Use $top (lower case only) when you are initially testing the response of the API by returning the first few entries.

For example, to return the first five entries (not sorted), use: ...API_NAME?$top=5

$filter=

Use $filter to insert conditions that narrow down the data, to return only entries where those conditions are true..

To limit the timeframe of a query, add $filter=relative_time() like, .../API_NAME?$filter=relative_time(last_x_hours) or (last_x_days). Learn more.

Create conditions for filtering with any of the following operators:

Query Operators Description
eq

Equal to

For example, COL4 eq 'val4'

ne

Not equal to

For example, COL4 ne 'val4'

gt

Greater than

For example, COL4 gt 'val4'

ge

Greater than or equal

For example, COL4 ge 'val4'

lt

Less than

For example, COL4 lt 'val4'

le

Less than or equal

For example, COL4 le 'val4'

and

Logical and

For example, COL1 eq 'value1' and COL2 ne 'value2'

or

Logical or

For example, COL1 eq 'value1' or COL2 ne 'value2'

not

Logical negation

Create conditions for filtering with any of the following functions:

Query Functions Description
startswith

For example, $filter=startswith(account_name,'Aternity')

endswith

For example, $filter=endswith(account_name,'Aternity')

contains

$filter=contains(COL5,'val5')

For example, $filter=contains(account_name,'Aternity')

Use operators with parentheses to group conditions logically: .../API_NAME?$filter=(COLUMN1 eq 'value1' or COL2 neq 'val2') and (COL3 gt number) and not (COL4 eq 'val4' or contains(COL5,'val5'))
$search is NOT supported.

Do not use $search in Aternity's REST APIs.

Output

Each entry from LICENSE_EVENTS returns a the last request from this device for a license, the type of license, and whether Aternity accepted or rejected the request with the reason.

Types Columns returned

Measurements

N/A

Attributes

Account_ID,Account_Name,Calendar_Date,Calendar_Month,Calendar_Week,License_Event,License_Event_Reason,License_Last_Event_Timestamp,License_Owner,License_Type,Virtual_Server_Name