View All Activities Not Reported to Aternity with REST API (version 1.0)

Use NOT_REPORTING_ACTIVITIES to view all activities which did NOT report to Aternity over the past seven days, because no one performed this action, or perhaps because of a problem with the activity's core definition, causing it to miss capturing an event in your application.

For example, if you created custom activities to monitor the new features in an application, this API would expose whether people are using your new feature.

Each entry from NOT_REPORTING_ACTIVITIES represents an activity whose volume is zero over the past seven days, and also includes the application name, and whether the activity is predefined.

Note

You can access data using this API (retention) going back up to seven days, 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.

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

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>/NOT_REPORTING_ACTIVITIES

To view only custom activities (not predefined) which did not report to Aternity during the past seven days, use:

.../NOT_REPORTING_ACTIVITIES?$select=ACTIVITY&$filter=IS_PREDEFINED eq 'False'

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 entry from NOT_REPORTING_ACTIVITIES represents an activity whose volume is zero over the past seven days, and also includes the application name, and whether the activity is predefined.

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

The returned columns are:

Account_ID, Account_Name, Activity, Application, Is_Predefined