View All Reported Activities with REST API (version 1.0)

Use ALL_ACTIVITIES to view all activities reported to Aternity over the past seven days. Use this API to get an overview of which activities are taking place, their frequency, and how many users are performing the activity.

For example, if you want to know the number of times someone performed your custom activities, use ALL_ACTIVITIES and filter for a specific application and only activities which are not predefined in Aternity.

Each returned entry from ALL_ACTIVITIES represents an activity, with details such as its application, the number of users who performed the activity, and the number of times the activity took place (volume).

Note

You can access data using this API (retention) going back up to seven days only, not less or more.

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. 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 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). 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 ALL_ACTIVITIES

To see the number of users who performed the new and open activities in MyBusinessApp, enter: .../ALL_ACTIVITIES?$filter=(ACTIVITY eq 'new' or ACTIVITY eq 'open') and APPLICATION eq 'MyBusinessApp'

To see each activity and the number of times people performed it, enter: .../ALL_ACTIVITIES?$select=ACTIVITY,VOLUME_IN_THE_LAST_7_DAYS

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

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.
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 returned entry from ALL_ACTIVITIES represents an activity, with details such as its application, the number of users who performed the activity, and the number of times the activity took place (volume).

You can access data using this API (retention) going back up to seven days only, not less or more.

The returned columns are:

Account_ID, Account_Name, Activity, Application, Is_Predefined, Last_Reported_Date, Users_in_the_Last_7_Days, Volume_in_the_Last_7_Days