Analyze the Raw List of Survey Responses with REST API

SURVEY_RESPONSE_RAW returns all responses for each question in a survey your enterprise sent to the employees. Use SURVEY_RESPONSE_RAW to get the survey results and analyze distribution of answers of employees to the questions.

Each entry from SURVEY_RESPONSE_RAW represents a question/answer combination in the survey per each submitted survey.

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

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

Also, use $orderby to sort the returned data in ascending or descending order. For example, .../API_NAME?$orderby=Activity_Response_Time desc or .../API_NAME?$orderby=Activity_Response_Time asc

The default is ascending.

$count=

Use $count=true to get the total count of items within a collection matching the request. This provides not distinct number of results.

Every REST API that supports aggregation will aggregate data automatically based on the columns in the $select parameter. 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. This eliminates the repetitive appearance of the same data.

So, the combination of the $count and Aternity aggregation mechanism will give you a distinct count of an attribute (or a combination of attributes). For example, if you want to know how many distinct applications were used in the last week you can run the following query:
.../aternity.odata/latest/applications_daily?$filter=relative_time(last_7_days)&$select=application_name&$count=true&$top=0
Another example, if you select a combination of attributes application_name,username, then you get a count of all the user/application combinations:
.../aternity.odata/latest/applications_daily?$filter=relative_time(last_7_days)&$select=select=application_name,username&$count=true&$top=0
Note that you cannot get distinct count in addition to other information. For example:
  • You cannot in one query get the number of distinct applications and the number of distinct users.

  • You cannot in one query get the number of distinct applications per day for every day in the last week.

  • You cannot in one query get all the data from applications_daily (usage, UXI, etc.) and the number of distinct applications.

Every distinct count for a specific attribute (or an attribute combination) and a specific filter requires a separate query.
$top=

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

Also, use $top to filter the returned data and to return only the first N 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')

in()

Instead of using AND, OR:

$filter=device_name eq ‘adam_covert_wks’ or device_name eq ‘adam_covert_vdi’ or device_name eq ‘adam_covert_tablet’

You can now use:

$filter=in(device_name,‘adam_covert_wks’,‘adam_covert_vdi’,‘adam_covert_tablet’)

Read carefully specific instructions for writing this function:
  • In must be followed directly by the opening parenthesis (no space allowed)

  • The first parameter is the field name (case insensitive)

  • The function requires at least two parameters, the field name and at least one field value

  • The rest of the parameters are the optional values that the field can have (i.e. the values we want to filter in) also case insensitive

  • Values are separated by comma and no spaces allowed

  • The maximum number of values in all clauses is 1,500 (e.g. It is possible to have 1 In() with 1500 values, or 2 In() clauses with 750 each).

  • The last value must be followed by the closing parenthesis (no space allowed)

  • In() can be combined with any other filter using AND or OR

  • There can be more than one in() function in a filter. For example, $filter=in(location,’loc1’,’loc2’) or in(subnet,’sub1’sub2’). Another example, $filter=in(location,’loc1’,’loc2’) and in(subnet,’sub1’sub2’)

relative_time(last_x_hours)

Limit the timeframe of a query.

If no relative_time filter is used to set a specific timeframe, Aternity will return the default last N days worth of data. Default values vary for different APIs. Learn here about specific REST API.

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

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

Types Columns returned

Measurements

Volume (Survey Responses)

Attributes

Account_ID,Account_Name,Business_Location,Calendar_Date,Calendar_Month,Calendar_Week,Client_Device_Name,Client_Device_Type,Corp_Channel,Corp_Line_Of_Business,Corp_Market,Corp_Store_ID,Corp_Store_Type,Custom_Attribute (1-6 or 1-9),Custom_Pilot_Group,Custom_User_Attribute_1_9,Data_Center_Business_Location,Device_Active_Subnet,Device_Connection_Location,Device_CPU_Cores,Device_CPU_Frequency,Device_CPU_Generation,Device_CPU_Model (a.k.a. CPU_Model),Device_CPU_Type,Device_Days_From_Last_Boot,Device_Domain,Device_Image_Build_Number,Device_IP_Address,Device_ISP,Device_Manufacturer,Device_Memory,Device_Model,Device_Name,Device_Network_Type,Device_Power_Plan,Device_Subnet,Device_Type,Is_Device_Used_RemotelyLocation_City,Location_Country,Location_On_Site,Location_On_VPN,Location_Region,Location_State,MS_Office_License_Type,MS_Office_Version,OS_Architecture,OS_BITLocker_Protection_Status,OS_Disk_Type,OS_Family,OS_Free_Disk_Space,OS_Name,OS_Version,Question,Question_Answer,Question_Answer_Number,Question_Answer_Sentiment,Question_Number,Survey_Description,Survey_Launch_Timestamp,Survey_Name,Survey_Response_Timestamp,User_Connection_Location,User_Department,User_Domain,User_Email_Address,Username,Virtualization,User_Full_Name,User_Office,User_Role,User_Title,Wifi_BSSID,Wifi_Channel,Wifi_SSID