Table of contents View the Details of Users Who Requested Access to your Account (REST API version 2.0) Use ATERNITY_USERS_ACCESS to view users who requested an access to the account, including the request details and its status. This query is helpful for auditing purposes when you want to know who from Aternity accesses your account. You can also view this data in the Aternity console, the Gear Icon > Users > Aternity Users Access tab. Learn more. Note About how long Aternity keeps this data (retention period) and how far back you can go, as well as about how many hours or days of data Aternity returns by default read here. Before You BeginTo 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 appTip Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more. 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 For this REST API Aternity returns the last 30 days worth of data. 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 None Attributes Account_ID,Action_By,Department,Details,Expiration,First_Name,Full_Name,Job_Title,Last_Accessed,Last_Name,Name,Request_Reason,Request_Status,Time,User_ID,User_Type Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksCreate Script for Collecting All Deployed Software on All DevicesSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceBest Practices for Returning Large Data Sets and How to Focus Your REST API Queries if Returned Data Too LargeSynchronize Aternity REST API (OData) With External Systems (Beta)View All Reported Activities with REST API (version 2.0)Analyze Resource Usage of a Managed Application (PRC) with REST API (version 2.0)Analyze the Raw List of Application Performance Reports with REST API (version 2.0)Analyze Application Performance Hourly or Daily with REST API (version 2.0)Analyze Application Performance Daily Anonymized (no PII) with REST API (version 2.0)View Baseline Values with REST API (version 2.0)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views with REST API (version 2.0)Audit the Changes Made by Aternity Users with Rest API (version 2.0)View Application Events with REST API (version 2.0)Analyze the Raw List of Activities with REST API (version 2.0)Analyze Activities Per Hour with REST API (version 2.0)Analyze Activities Per Day with REST API (version 2.0)Analyze Activities Per Day Anonymized (no PII) with REST API (version 2.0)View All Activities Not Reported to Aternity with REST API (version 2.0)Analyze the Boot Times of Devices with REST API (version 2.0)Analyze the Boot Times of Windows Boot Components with REST API (version 2.0)Analyze Device Inventory with REST API (version 2.0)Analyze Device Health Events with REST API (version 2.0)Analyze Daily Device Health Anonymized (no PII) with REST API (version 2.0)Analyze Device (Agent) Status with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) Anonymized (no PII) with REST API (version 2.0)Analyze Device's Resource Usage (HRC) with REST API (version 2.0)Analyze the Incidents Opened in Aternity with REST API (version 2.0)View Deployed Applications on All Devices with REST API (Installed Software) (version 2.0)View Software Changes on All Devices with REST API (Installed Software Change Log) (version 2.0)View Requests of Licenses in REST API (License Events)Analyze Inventory of Monitored Mobile Apps with REST API (version 2.0)Analyze Service Desk Alerts with REST API (version 2.0)Analyze Skype for Business Performance with REST API (version 2.0)Analyze WiFi Signal Strength and Reliability with REST API (version 2.0)Analyze the Raw List of Custom Data with REST API (version 2.0)Analyze Custom Data Hourly or Daily with REST API (version 2.0)Analyze Custom Data Daily Anonymized (no PII) with REST API (version 2.0)Analyze Inventory of Remediation Actions with REST API (version 2.0)View Executed Remediation Actions With REST API (version 2.0)Analyze Daily Remediation Actions Anonymized (no PII) with REST APIAnalyze the Raw List of Remote Display Latency Reports with REST APIAnalyze Remote Display Latency Hourly or Daily with REST APIAnalyze Remote Display Latency Daily Anonymized (no PII) with REST API (version 2.0)Analyze the Raw Data of the Calls in MS Teams with REST API (version 2.0)Analyze Application Anomalies with REST API (version 2.0)View the Details of a User with REST API (version 2.0)Related informationAternity REST API Column Names (version 2.0) SavePDF Selected topic Selected topic and subtopics All content Related Links
View the Details of Users Who Requested Access to your Account (REST API version 2.0) Use ATERNITY_USERS_ACCESS to view users who requested an access to the account, including the request details and its status. This query is helpful for auditing purposes when you want to know who from Aternity accesses your account. You can also view this data in the Aternity console, the Gear Icon > Users > Aternity Users Access tab. Learn more. Note About how long Aternity keeps this data (retention period) and how far back you can go, as well as about how many hours or days of data Aternity returns by default read here. Before You BeginTo 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 appTip Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more. 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 For this REST API Aternity returns the last 30 days worth of data. 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 None Attributes Account_ID,Action_By,Department,Details,Expiration,First_Name,Full_Name,Job_Title,Last_Accessed,Last_Name,Name,Request_Reason,Request_Status,Time,User_ID,User_Type Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksCreate Script for Collecting All Deployed Software on All DevicesSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceBest Practices for Returning Large Data Sets and How to Focus Your REST API Queries if Returned Data Too LargeSynchronize Aternity REST API (OData) With External Systems (Beta)View All Reported Activities with REST API (version 2.0)Analyze Resource Usage of a Managed Application (PRC) with REST API (version 2.0)Analyze the Raw List of Application Performance Reports with REST API (version 2.0)Analyze Application Performance Hourly or Daily with REST API (version 2.0)Analyze Application Performance Daily Anonymized (no PII) with REST API (version 2.0)View Baseline Values with REST API (version 2.0)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views with REST API (version 2.0)Audit the Changes Made by Aternity Users with Rest API (version 2.0)View Application Events with REST API (version 2.0)Analyze the Raw List of Activities with REST API (version 2.0)Analyze Activities Per Hour with REST API (version 2.0)Analyze Activities Per Day with REST API (version 2.0)Analyze Activities Per Day Anonymized (no PII) with REST API (version 2.0)View All Activities Not Reported to Aternity with REST API (version 2.0)Analyze the Boot Times of Devices with REST API (version 2.0)Analyze the Boot Times of Windows Boot Components with REST API (version 2.0)Analyze Device Inventory with REST API (version 2.0)Analyze Device Health Events with REST API (version 2.0)Analyze Daily Device Health Anonymized (no PII) with REST API (version 2.0)Analyze Device (Agent) Status with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) Anonymized (no PII) with REST API (version 2.0)Analyze Device's Resource Usage (HRC) with REST API (version 2.0)Analyze the Incidents Opened in Aternity with REST API (version 2.0)View Deployed Applications on All Devices with REST API (Installed Software) (version 2.0)View Software Changes on All Devices with REST API (Installed Software Change Log) (version 2.0)View Requests of Licenses in REST API (License Events)Analyze Inventory of Monitored Mobile Apps with REST API (version 2.0)Analyze Service Desk Alerts with REST API (version 2.0)Analyze Skype for Business Performance with REST API (version 2.0)Analyze WiFi Signal Strength and Reliability with REST API (version 2.0)Analyze the Raw List of Custom Data with REST API (version 2.0)Analyze Custom Data Hourly or Daily with REST API (version 2.0)Analyze Custom Data Daily Anonymized (no PII) with REST API (version 2.0)Analyze Inventory of Remediation Actions with REST API (version 2.0)View Executed Remediation Actions With REST API (version 2.0)Analyze Daily Remediation Actions Anonymized (no PII) with REST APIAnalyze the Raw List of Remote Display Latency Reports with REST APIAnalyze Remote Display Latency Hourly or Daily with REST APIAnalyze Remote Display Latency Daily Anonymized (no PII) with REST API (version 2.0)Analyze the Raw Data of the Calls in MS Teams with REST API (version 2.0)Analyze Application Anomalies with REST API (version 2.0)View the Details of a User with REST API (version 2.0)Related informationAternity REST API Column Names (version 2.0)
View the Details of Users Who Requested Access to your Account (REST API version 2.0) Use ATERNITY_USERS_ACCESS to view users who requested an access to the account, including the request details and its status. This query is helpful for auditing purposes when you want to know who from Aternity accesses your account. You can also view this data in the Aternity console, the Gear Icon > Users > Aternity Users Access tab. Learn more. Note About how long Aternity keeps this data (retention period) and how far back you can go, as well as about how many hours or days of data Aternity returns by default read here. Before You BeginTo 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 appTip Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more. 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 For this REST API Aternity returns the last 30 days worth of data. 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 None Attributes Account_ID,Action_By,Department,Details,Expiration,First_Name,Full_Name,Job_Title,Last_Accessed,Last_Name,Name,Request_Reason,Request_Status,Time,User_ID,User_Type Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksCreate Script for Collecting All Deployed Software on All DevicesSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceBest Practices for Returning Large Data Sets and How to Focus Your REST API Queries if Returned Data Too LargeSynchronize Aternity REST API (OData) With External Systems (Beta)View All Reported Activities with REST API (version 2.0)Analyze Resource Usage of a Managed Application (PRC) with REST API (version 2.0)Analyze the Raw List of Application Performance Reports with REST API (version 2.0)Analyze Application Performance Hourly or Daily with REST API (version 2.0)Analyze Application Performance Daily Anonymized (no PII) with REST API (version 2.0)View Baseline Values with REST API (version 2.0)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views with REST API (version 2.0)Audit the Changes Made by Aternity Users with Rest API (version 2.0)View Application Events with REST API (version 2.0)Analyze the Raw List of Activities with REST API (version 2.0)Analyze Activities Per Hour with REST API (version 2.0)Analyze Activities Per Day with REST API (version 2.0)Analyze Activities Per Day Anonymized (no PII) with REST API (version 2.0)View All Activities Not Reported to Aternity with REST API (version 2.0)Analyze the Boot Times of Devices with REST API (version 2.0)Analyze the Boot Times of Windows Boot Components with REST API (version 2.0)Analyze Device Inventory with REST API (version 2.0)Analyze Device Health Events with REST API (version 2.0)Analyze Daily Device Health Anonymized (no PII) with REST API (version 2.0)Analyze Device (Agent) Status with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) with REST API (version 2.0)Analyze Daily Device Resource Usage (HRC) Anonymized (no PII) with REST API (version 2.0)Analyze Device's Resource Usage (HRC) with REST API (version 2.0)Analyze the Incidents Opened in Aternity with REST API (version 2.0)View Deployed Applications on All Devices with REST API (Installed Software) (version 2.0)View Software Changes on All Devices with REST API (Installed Software Change Log) (version 2.0)View Requests of Licenses in REST API (License Events)Analyze Inventory of Monitored Mobile Apps with REST API (version 2.0)Analyze Service Desk Alerts with REST API (version 2.0)Analyze Skype for Business Performance with REST API (version 2.0)Analyze WiFi Signal Strength and Reliability with REST API (version 2.0)Analyze the Raw List of Custom Data with REST API (version 2.0)Analyze Custom Data Hourly or Daily with REST API (version 2.0)Analyze Custom Data Daily Anonymized (no PII) with REST API (version 2.0)Analyze Inventory of Remediation Actions with REST API (version 2.0)View Executed Remediation Actions With REST API (version 2.0)Analyze Daily Remediation Actions Anonymized (no PII) with REST APIAnalyze the Raw List of Remote Display Latency Reports with REST APIAnalyze Remote Display Latency Hourly or Daily with REST APIAnalyze Remote Display Latency Daily Anonymized (no PII) with REST API (version 2.0)Analyze the Raw Data of the Calls in MS Teams with REST API (version 2.0)Analyze Application Anomalies with REST API (version 2.0)View the Details of a User with REST API (version 2.0)Related informationAternity REST API Column Names (version 2.0)