List Dimensions

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

In this article

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

You will usually find it simpler to manage dimensions through the Administration Console (see Manage Dimensions on Custom Metadata). This article is only relevant if you have a legitimate reason for listing dimensions programmatically.

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

200 OK response body (excerpt)

[
  ...
  {
    "type": "DATE",
    "displayName": "Day",
    "apiNames": [
      "ACTIONDAYOFYEAR",
      "ACTIONS.ACTIONDAYOFYEAR",
      "DAYOFYEAR",
      "DAY"
    ],
    "returnName": "actionDayOfYear",
    "custom": false,
    "availableInVisit": false,
    "eventTypes": [
      "searches",
      "custom_events",
      "clicks",
      "views"
    ],
    "status": "AVAILABLE"
  },
  ...
]

You may then want to use the displayName value to learn more about the dimensions (e.g., Day).

You can also create new dimensions if desired.