Downloading a Smart Engine Report with the API

Use the API to download Smart Engine reports generated for an app instance.

To download a of Smart Engine report 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.
Report ID — ID of the report to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports method.

Use the POST /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports/generate method to generate a Smart Engine report for an app instance.
Use the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports/{reportId} method to download your report.

Related Topics