How to Query the CPQ Metrics API

Introduction

Beginning in release 24D, Oracle CPQ customers can download daily business metrics to either a CSV file or as JSON via a new REST API endpoint. Previously, CPQ site metrics were reported to the Oracle Cloud My Account Portal but form now on this self-service capability enables customers to gain insight into their CPQ application and the business impact over time. 

You can review the feature download business metrics to a CSV file in the 24D What’s New documentation. This post will focus on how you can use the new Metrics REST API.

Available Business Metrics

There are a number of types of values that are available via the Metrics REST API including API, Login, and Quoting metrics. You can find a list of all the available metrics Oracle CPQ documentation. Metrics are listed below with the name as it appears in the Metrics REST API JSON response

API Metrics

Login Metrics

Quote & Quote Performance Metrics

REST API Endpoint Usage

Use the Metrics REST API endpoint to retrieve all business metrics in a 24-hour UTC interval, where {{host}} is your Oracle CPQ host and {{version}} your supported version (v17+)

GET https://{{host}}/rest/{{version}}/metrics

The endpoint supports the q parameter which declares a query specification expression in MongoDB format. See MongoDB Query Specifications for more information in how to user the syntax.

Example Requests

Some example use cases for employing the q parameter to filter the results are:

• All relevant metrics are calculated once per day so retrieve one day’s worth of metrics by querying the dateAdded attribute.

  • {$and:[{dateAdded:{$gt:"2025-02-18"}},{dateAdded:{$lt:"2025-02-19"}}]}

• Get metrics by type and date added

  • {$and:[{name:"NEWQUOTE90RESPONSETIME"},{dateAdded:{$gt:"2025-01-01"}},{dateAdded:{$lt:"2025-01-31"}}]}

• Get all metrics based on start and end times. Note, the start and end times are not consistent across all metrics.

  • {$and:[{startTime:{$gte:"2025-02-19T00:00:00.000Z"}},{endTime:{$lte:"2025-02-19T23:59:59.000Z"}}]}

• Get all metrics by type

  • {name:"NEWQUOTE90RESPONSETIME"}

• Get all metrics by multiple types

  • {name:{$in:["NEWQUOTE90RESPONSETIME", "NEWQUOTEAVGRESPONSETIME"]}}

Example Response

So that you know what you’ll be working with, here’s an example response for the request:

GET https://{{host}}/rest/{{version}}/metrics?offset=0&limit=1000&q={name:\”NEWQUOTE90RESPONSETIME\”}&totalResults=true

{
    "items": [
        {
            "metricsId": "1000000163",
            "name": "NEWQUOTE90RESPONSETIME",
            "value": "8322",
            "startTime": "2025-02-18T00:00:00.000Z",
            "endTime": "2025-02-18T23:59:59.000Z",
            "dateModified": "2025-02-19T14:00:06.000Z",
            "dateAdded": "2025-02-19T14:00:06.000Z"
        },
        {
            "metricsId": "1000000163",
            "name": "NEWQUOTE90RESPONSETIME",
            "value": "6436",
            "startTime": "2025-02-17T00:00:00.000Z",
            "endTime": "2025-02-17T23:59:59.000Z",
            "dateModified": "2025-02-18T14:00:07.000Z",
            "dateAdded": "2025-02-18T14:00:07.000Z"
        }
   ],
    "offset": 0,
    "limit": 1000,
    "count": 2,
    "totalResults": 2,
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://{{host}}/rest/{{version}}/metrics"
        },
        {
            "rel": "self",
            "href": "https://{{host}}/rest/{{version}}/metrics?offset=0&limit=1000&q={name:\"NEWQUOTE90RESPONSETIME\"}&totalResults=true"
        }
    ]
}

Summary

Remember if you want to simply download a CSV file with the business metrics, follow the instructions in the steps to enable. However, if you want to script the regular download of metrics so you can integrate with other business reporting, the Metrics REST API is the way to go.

Happy hunting!

~sn