Metrics REST API

Overview

The Metrics REST API is used to retrieve all business metrics within the Oracle CPQ application, including API, Login, Quoting, and Quoting Performance metrics. The Metrics are available for daily monitoring.

The Metrics REST API is only available for FullAccess users with administrative permissions and access to the Commerce Settings and/or General Site Settings.

Administration

Get All Business Metrics

Get All Business Metrics
Description	This endpoint retrieves all business metrics available within the Oracle CPQ application for daily monitoring.
URI Endpoint	/rest/v17/metrics
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks – Exclude links from the response. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the business metrics.

URI Endpoint Sample

Sample Response Body

Metrics REST API

Overview

Administration

Related Topics