Analyze Device (Agent) Status with REST API (version 2.0)

REPORTING_AGENTS_COUNT returns a summary of the number of reporting devices in each location over the past seven days, to quickly determine whether all devices are continually reporting data. It returns a summary of three types of reporting devices:

  • REPORTING_AGENTS where the Agent for End User Devices status was reporting.

  • CONNECTED_AGENTS where the Agent status was reporting, stopped or not reporting.

  • CONNECTED_REMOTE_DEVICES where the Agent status was reporting, but where the device does not have a locally installed Agent (like a device running a monitored virtual application).

For example, if you suspect there are gaps in your Aternity data, you can use the summary returned by REPORTING_AGENTS_COUNT to view the total devices reporting in each location and compare it with the expected number of actual devices in use.

Each entry from REPORTING_AGENTS_COUNT represents a summary of the number of reporting devices of single type in a single location.

Note

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

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/REPORTING_AGENTS_COUNT or <base_url>/v2/REPORTING_AGENTS_COUNT

To view the number of reporting Agents for each type of device, enter:

.../REPORTING_AGENTS_COUNT?$select=DEVICE_TYPE,REPORTING_AGENTS

To view the total number of devices reporting in a location, enter:

.../REPORTING_AGENTS_COUNT?$select=LOCATION,REPORTING_AGENTS

To check if there are Agent for End User Devicess on devices encountered errors and have a status of Stopped, enter:

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

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.

Tip

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

Output

Each entry from REPORTING_AGENTS_COUNT represents a summary of the number of reporting devices of single type in a single location.

You can access data using this API (retention) going back up to seven days.

Sample output from this API

The API returns two types of columns: Attributes (or dimensions) which are the properties of an entry, and Measurements which are the dynamic measured values.

Type Returned columns

Measurements

Connected_Agents,Connected_Remote_Devices,Reporting_Agents

Attributes

Account_ID,Account_Name,Business_Location,Device_Type