Analyze WiFi Signal Strength and Reliability with REST API (version 1.0)

WIFI_STATISTICS_HOURLY tracks the customer experience of WiFi in your enterprise by returning an hourly summary of the WiFi details like its speed, signal strength, and access points for each monitored device.

For example, use this API to monitor WiFi experience in offices, especially if you are planning to make the default network access via WiFi. Use the information here to cross-reference with application performance, especially those which rely heavily on a strong network connection, like Skype calls.

Each entry from WIFI_STATISTICS_HOURLY returns a single device's WiFi details during a one-hour slot, including its WiFi speed, signal strength, WiFi access point (SSID or BSSID), and (Macs only) the WiFi noise level and signal-to-noise ratio (SNR). If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements.

Note

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

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 an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

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>/WIFI_STATISTICS_HOURLY

If you notice long network times for employees in your London branch, you can check if poor WiFi contributes to this problem, by viewing last week's average, maximum and minimum signal strength in that location:

<base_url>/WIFI_STATISTICS_HOURLY?$select=Wifi_Signal_Strength_Avg,Wifi_Signal_Strength_Max,Wifi_Signal_Strength_Min&$filter=(relative_time(last_week) and LOCATION_CITY eq 'London')

You can use this API to determine whether you need more WiFi transmitters in an office by checking if all people in one physical room (say, the Purchasing department) are consistently suffering from poor WiFi. Filter for people in a specific department in a specific location and view their signal strength:

<base_url>/WIFI_STATISTICS_HOURLY?$select=Wifi_Signal_Strength_Avg,Wifi_Signal_Strength_Max,Wifi_Signal_Strength_Min&$filter=(LOCATION_CITY eq 'London' and USER_DEPARTMENT eq 'Purchasing')

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.

Parameter Description
$select=

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

$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 with operators: and, or, eq (equals) gt (greater than), ge (greater than or equal), lt (less than), le (less than or equal), ge (greater than or equal to), ne (not equal to), le (less than or equal to), not and contains. 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'))

$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

$search is NOT supported.

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

If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements. For example, if you use $select to return only the RAM size and CPU usage, if 50 devices have the same attribute of 16GB RAM, it condenses them into a single row and outputs their CPU usage as a single weighted average measurement.

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 WIFI_STATISTICS_HOURLY returns a single device's WiFi details during a one-hour slot, including its WiFi speed, signal strength, WiFi access point (SSID or BSSID), and (Macs only) the WiFi noise level and signal-to-noise ratio (SNR). If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements.

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

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. A single API row can display either a single measurement, or a weighted average of several entries grouped together. If you use $select to display several attributes, and all those attributes are identical, it groups them into a single entry.

Type Returned columns

Measurement

Wifi_Noise_Level_Avg, Wifi_Noise_Level_Max, Wifi_Noise_Level_Min,Wifi_Signal_Strength_Avg, Wifi_Signal_Strength_Max, Wifi_Signal_Strength_Min,Wifi_SNR_Avg, Wifi_SNR_Max, Wifi_SNR_Min,Wifi_Transmission_Speed_Avg, Wifi_Transmission_Speed_Max, Wifi_Transmission_Speed_Min

Attribute

Account_ID,Account_Name,Business_Location,Change_Pilot_Group,Channel,CPU_Cores,CPU_Frequency,CPU_Generation,CPU_Model,CPU_Type,Custom_Attribute_1 - 6,Days_From_Last_Boot,Device_Idle_This_Hour,Device_Manufacturer,Device_Model,Device_Name,Device_Type,Hours_on_WiFi,Image_Build_Number,IP_Address,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Machine_Power_Plan,Market,Memory_Size,MS_Office_License_Type,Mobile_Device_ID,MS_Office_Version,Network_Type,On_Site,On_VPN,OS_Architecture,OS_Disk_Type,OS_Family,OS_Name,OS_Version,Store_ID,Store_Type,Subnet,Timeframe,User_Department,User_Domain,User_Email_Address,User_Full_Name,User_Office,User_Role,User_Title,Username,Wifi_SSID,Wifi_BSSID,Wifi_Channel