Viewing a List of Smart Engine Reports with the API

Use the API to view a list of reports generated for a specific app instance using the POST /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports/generate method. To generate reports see, Generating Smart Engine Reports with the API.

Note: Reports are auto-generated when trigger conditions are met, such as increased memory usage, high CPU usage, or more live threads for a specified amount of time. Therefore, you may see more reports than expected when you get the list of available Smart Engine reports.

To view a list of Smart Engine reports for an app instance you need the following:

Subscription Locator — The Subscription Locator of the Organization you want to access. To find Subscription Locators for your organizations use the GET /v1/userinfo method to return a list of all of the organizations for your OAuth Token with their Subscription Locators. You can use 0 as the Subscription Locator for the organization that owns the OAuth token.
App ID — ID of the app to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps method.
App Instance ID — ID of the app instance to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances method.

Use the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports method to get the list of reports.

Viewing a List of Smart Engine Reports with the API

Related Topics