Audit the Number of Dashboard Views with REST API

DASHBOARD_VIEWS_AUDIT returns a list of Aternity dashboards that users accessed over the past seven days, and the username and time of each access, so that you can audit or monitor the users who view different parts of Aternity.

For example, you can monitor the frequency with which your helpdesk personnel are checking the Incidents dashboard by calling this API and filtering for the helpdesk usernames.

Each entry from DASHBOARD_VIEWS_AUDIT represents a single dashboard access, and provides details about that event.

Note

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

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter an Aternity username which has the OData Role privilege, and its password. For SSO users, generate your own Aternity REST API password by selecting User icon > REST API Password. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmith

To view an Aternity REST API, enter the URL: <base_url>/API_NAME from a browser, Excel or PowerBI (learn more). The <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):

http://odata-aternity.company.com:80/aternity.odata/API_NAME
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>/DASHBOARD_VIEWS_AUDIT

To return the list of people (Aternity usernames) who opened the Enterprise Summary dashboard in the past week, use:

.../DASHBOARD_VIEWS_AUDIT?$select=user_name&$filter=DASHBOARD_NAME eq 'EnterpriseSummary' and relative_time(last_week) and ACTION eq 'Open Dashboard'

To see the same list along with a timestamp when each one opened the dashboard, use:

.../DASHBOARD_VIEWS_AUDIT?$select=user_name,timeframe&$filter=DASHBOARD_NAME eq 'EnterpriseSummary' and relative_time(last_week) and ACTION eq 'Open Dashboard'

To see the list of dashboards which a user accessed in Aternity yesterday, use:

.../USER_AUDIT?$select=DASHBOARD_NAME&filter=user_name eq 'jsmith@company.com' and relative_time(yesterday)

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 .../aternity.odata/API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../aternity.odata/API_NAME?$format=xml&$top=5.

Parameter Description
$filter=

Use $filter to insert conditions which narrow down the data, to return only entries where those conditions are true. .

Combine several parameters using 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) and le (less than or equal to). You can also use the text operator contains, though it significantly slows the API performance.

Aternity also supports the not operator, which negates the query expression that follows it. For example, .../aternity.odata/API_NAME?$filter=(CLIENT_DEVICE_TYPE eq 'Laptop' or CLIENT_DEVICE_TYPE eq 'Tablet') and not(LOCATION_CITY eq 'Miami' or LOCATION_CITY eq 'Los Angeles') will return data for laptops and tablets for all locations except Miami and Los Angeles. For details on these OData parameters that are supported by Aternity, see Microsoft's OData documentation.

Use the relative_time() filter to easily limit the timeframe of your query. For example, .../aternity.odata/API_NAME?$filter=relative_time(yesterday). Possible values are:

  • last_6_hours: Shows data starting from exactly six hours ago, displaying it summarized (aggregated) according to the view you selected.

  • last_24_hours: Shows data starting exactly this time yesterday, displaying it summarized (aggregated) according to the view you selected.

  • today: Displays data starting from 00:00AM today in the time zone of the Aternity Management Server.

  • yesterday: Displays data starting from 00:00AM yesterday according to the time zone of the Aternity Management Server.

  • last_48_hours: Displays data starting exactly this time two days ago, displaying it summarized (aggregated) according to the view you selected.

  • last_7_days: Displays data starting from 00:00AM seven days ago in the time zone of the Aternity Management Server.

  • this_week: Displays data for this week, beginning from 00:00 AM on Sunday morning according to the time zone of the Aternity Management Server, until the current time.

  • last_week: Displays data from 00:00AM on Sunday morning to 23:59 on the most recent Saturday night according to the time zone of the Aternity Management Server. Use this view to compare consistent weekly results.

  • last_14_days: Displays data from exactly this time 14 days ago, displaying it summarized (aggregated) according to the view you selected.

  • last_30_days: Displays data from exactly this time 30 days ago, displaying it summarized (aggregated) according to the view you selected.

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for programmers or those testing the raw data in a web browser. For example:

.../aternity.odata/API_NAME?$format=xml

$orderby

Use $orderby to order the returned data according to the value you choose. For example, to order results device inventory results based on location, use .../aternity.odata/DEVICE_INVENTORY?$orderby=LOCATION

$select=

Use $select to return only the data of specific columns (attributes). To return several columns, list them separated by a comma (no space).

For example, to return only the application and department, use:

.../aternity.odata/API_NAME?$select=APPLICATION,DEPARTMENT&...

$top=

Use $top (lower case only, not TOP) 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 in any way), use:

.../aternity.odata/API_NAME?$top=5

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 DASHBOARD_VIEWS_AUDIT represents a single dashboard access, and provides details about that event.

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

The returned columns are:

Account_ID,Account_Name,Dashboard_Name,Timeframe,User_Name