Usages of the Analytical Reporting API

The Analytical Reporting API can be used synchronously or asynchronously, and should not be confused with the Operational Reporting APIs; this API reports on facts and dimensions, while the Operational Reporting APIs report on transactional data from business documents.

The SAP Ariba Analytical Reporting API enables you to create a client application that extracts reportable data from reporting facts and dimensions such as you would select in the user interface when creating an analytical report. For example, you could use this API to extract and report on the analytical data that you need to import to a customer's warehouse or create dashboards for trend assessment.

This API should not be confused with the various operational reporting APIs. Here are a few use cases to help you decide whether the Analytical reporting API or (for example) the Operational reporting API for procurement is most appropriate for your needs:

Use the Analytical reporting API for...

Use the Operational reporting API for procurement for...

Amount of PO spend by department

Invoice accrual report

Contract versus off-contract spend

Invoices not paid

List of sourcing documents waiting to be approved

OK-to-pay report

Your client application filters the particular type of data you wish to extract by specifying records, time-span, and other considerations. These filters are included in reporting view templates. You can create a custom view template using specific API calls, or you can use one of the pre-defined system view templates. A particular view template is created only once, and persists in the system. The client application must specify the view by name with each API call.

Asynchronous Versus Synchronous Usage

The Analytical reporting API can be used synchronously to retrieve smaller data sets, or asynchronously to retrieve larger data sets. In both the asynchronous and the synchronous usages, the response is in JSON format.

In the asynchronous usage, requested output is batched into ZIP files containing 5,000 records per file for views with vector fields, also called multi-value list fields. These files can be downloaded one at a time. The maximum number of records returned for views with vector fields is 50,000, or 10 files containing 5,000 records per file.

If a view doesn’t contain vector fields, then an asynchronous analytical reporting API call against it delivers up to 50,000 records per ZIP file. Your administrator can configure the following self-service parameters to improve the speed and throughput of non-vector analytical reporting API requests:

Files created in response to an asynchronous API query expire after 48 hours. As a best practice, we recommend this usage when you update analytical data to your data warehouse.

In the synchronous usage, requested output is batched and paginated, and results are returned one page at a time. The maximum number of records returned is 50,000. As a best practice, we recommend this API be used synchronously only with custom view templates with few fields and short filter date ranges. For example, this usage would be good for checking how many sourcing projects will expire next month and returning their names.