List Metrics

Analyze Usage Data Coveo Relevance Cloud Business Analyst System Administrator Product Documentation

In this article

The Coveo Usage Analytics (Coveo UA) Read API metrics endpoint allows you to retrieve the list of metrics in your Coveo organization (see /v15/metrics). Ensure that you’re using an access token with the Analytics - Analytics data - View privilege in the target Coveo organization (see Add an API Key).

GET https://analytics.cloud.coveo.com/rest/ua/v15/metrics?org=myOrg HTTP/1.1
 
Authorization: Bearer **********-****-****-****-************

200 OK response body (excerpt)

{
  "metricResponses": [
    {
      "metricName": "PerformSearch",
      "displayName": "Search Event Count",
      "type": "Integer",
      "higherIsBetter": null,
      "percentage": false,
      "summable": true,
      "eventTypes": [
        "searches"
      ],
      "availableInVisit": false
    },
    ...
  ],
  ...
}

You may then want to use the displayName value to learn more about the metrics (e.g., Search Event Count).