Table of contents Audit the Changes Made by Aternity Users with Rest API (version 2.0) Use CHANGE_AUDIT_LOG to get audit records of all changes that were made by Aternity users. For example, use CHANGE_AUDIT_LOG API to see who removed a user from Aternity, who changed passwords, updated licenses, deleted activities, updated roles, or performed any other change in Aternity. Note You can access data using this API (retention) going back up to 365 days. If you do not add a relative_time filter, by default it returns data for the past day. 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. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmithTo 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 appThe <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):http://odata-aternity.company.com:80/aternity.odata/v2/API_NAMETip 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/CHANGE_AUDIT_LOG Use change_audit_log?$filter=change_type eq 'REMOVE_USER' to see who removed some user from Aternity. 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. 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 365 days. If you do not add a relative_time filter, by default it returns data for the past day. The returned columns are: Account_ID,Account_Name,Change_Type,Change,Change_Additional_Information,User_Name,Change_Timestamp Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceFocus Your REST API Queries if Returned Data Too LargeView 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)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views 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 Device Inventory 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)View System Health Events 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
Audit the Changes Made by Aternity Users with Rest API (version 2.0) Use CHANGE_AUDIT_LOG to get audit records of all changes that were made by Aternity users. For example, use CHANGE_AUDIT_LOG API to see who removed a user from Aternity, who changed passwords, updated licenses, deleted activities, updated roles, or performed any other change in Aternity. Note You can access data using this API (retention) going back up to 365 days. If you do not add a relative_time filter, by default it returns data for the past day. 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. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmithTo 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 appThe <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):http://odata-aternity.company.com:80/aternity.odata/v2/API_NAMETip 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/CHANGE_AUDIT_LOG Use change_audit_log?$filter=change_type eq 'REMOVE_USER' to see who removed some user from Aternity. 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. 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 365 days. If you do not add a relative_time filter, by default it returns data for the past day. The returned columns are: Account_ID,Account_Name,Change_Type,Change,Change_Additional_Information,User_Name,Change_Timestamp Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceFocus Your REST API Queries if Returned Data Too LargeView 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)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views 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 Device Inventory 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)View System Health Events with REST API (version 2.0)Related informationAternity REST API Column Names (version 2.0)
Audit the Changes Made by Aternity Users with Rest API (version 2.0) Use CHANGE_AUDIT_LOG to get audit records of all changes that were made by Aternity users. For example, use CHANGE_AUDIT_LOG API to see who removed a user from Aternity, who changed passwords, updated licenses, deleted activities, updated roles, or performed any other change in Aternity. Note You can access data using this API (retention) going back up to 365 days. If you do not add a relative_time filter, by default it returns data for the past day. 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. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmithTo 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 appThe <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):http://odata-aternity.company.com:80/aternity.odata/v2/API_NAMETip 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/CHANGE_AUDIT_LOG Use change_audit_log?$filter=change_type eq 'REMOVE_USER' to see who removed some user from Aternity. 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. 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 365 days. If you do not add a relative_time filter, by default it returns data for the past day. The returned columns are: Account_ID,Account_Name,Change_Type,Change,Change_Additional_Information,User_Name,Change_Timestamp Parent topic Overview for Analyzing with Aternity REST API v2 (OData)Related tasksSave the Cost of Unused Licenses by Viewing Software Installed but Never UsedRelated referenceFocus Your REST API Queries if Returned Data Too LargeView 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)Audit Aternity Access with REST API (version 2.0)Audit the Number of Dashboard Views 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 Device Inventory 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)View System Health Events with REST API (version 2.0)Related informationAternity REST API Column Names (version 2.0)