Endpoints Included in the Analytical Reporting API

The Analytical Reporting API includes endpoints for view template management and for asynchronous and synchronous reporting.

The Analytical Reporting API includes the following sets of endpoints, each of which has its own discovery page on the SAP Ariba Developer Portal:

Analytical Reporting - View Management API

Allows you to work with reporting view templates, which are used to specify the filters that determine what data will be returned in response to an API request using the Analytical reporting API. A reporting view template specifies the type of records to report on, the reporting fields to be included in the API response, and selection filters to select relevant records for inclusion.

Endpoint	Description
POST /viewTemplates/{viewTemplateName}	Create a new view template.
GET /viewTemplates/{viewTemplateName}	View the details of the specified view template.
GET /viewTemplates	View all view templates for a realm.
POST /viewTemplates/{viewTemplateName}/patch	Update the specified view template.
GET /metadata	Request a list of supported facts and dimensions, or a list of filter and selection fields by fact/dimension. These fields, facts, and dimensions can be used to create custom view templates.

Analytical Reporting - Job Submission API

Allows you to submit larger jobs for asynchronous processing, using reporting view templates.

Endpoint	Description
POST /jobs	Submit a job for asynchronous processing. To retrieve the output, use the Analytical Reporting - Job Results API.

Analytical Reporting - Job Results API

Allows you to request output from asynchronous jobs posted using the Job submission API for analytics. Requested output is batched into ZIP files containing 5000 records per file, and these can be downloaded one at a time.

Endpoint	Description
GET /jobs/{jobId}/files/{fileId}	Request ZIP files from the specified completed asynchronous analytical reporting job, one ZIP file at a time.
GET /jobs/{jobId}	Request the status of the specified asynchronous analytical reporting job.

Analytical Reporting - Synchronous API

Allows you to submit smaller requests and receive results synchronously. In the synchronous usage, requested output is batched and paginated, and results are returned one page at a time.

Endpoint	Description
GET /views/{viewTemplateName}	Synchronously request output that satisfies the criteria in the specified view template. Output is batched and paginated, and JSON results are returend one page at a time.