Retrieve List of Available Metrics

Retrieve the catalog of metric names your account supports, so you can discover valid Metrics V3 API metric names programmatically instead of hard-coding them.

Updated 2026-09-24 retrieve-list-of-available-metrics

Retrieve List of Available Metrics

Retrieve the catalog of metric names your account supports. Use this endpoint to discover the exact metric names to use in Metrics V3 API request paths, rather than hard-coding them or guessing. The singular list holds every metric you can request on its own or add to a custom-selection call, and the response also lists the dimensions, parameters, and per-metric endpoints available to the account.

Method

GET

Endpoint

Copy
https://api.conviva.com/insights/3.0/metrics

API Responses

   

Example cURL

Copy
curl --netrc --request GET \
  --url https://api.conviva.com/insights/3.0/metrics \
  --header 'Accept: application/json'

Example Response (truncated)

Copy
{
  "metrics": {
    "singular": [
      "abandonment",
      "ad-attempts",
      "attempts",
      "bitrate",
      "concurrent-plays",
      "ended-plays",
      "plays",
      "rebuffering-ratio",
      "video-playback-failures",
      "video-start-failures"
      // ... all supported singular metric names
    ],
    "multiple": [
      "custom-selection"
    ]
  },
  "dimensions": [
    "ad-break-id",
    "asset",
    "device-os",
    "geo-country-code",
    "isp"
    // ... all supported group-by dimension names
  ],
  "format": {
    "time_series": "https://api.conviva.com/insights/3.0/metrics/{metric_name}",
    "group_by": "https://api.conviva.com/insights/3.0/metrics/{metric_name}/group-by/{dimension_name}"
  }
  // response also includes "parameters", "references", and "resources"
}

The metrics.singular array lists every metric name you can request on its own (for example, attempts) or pass to custom-selection. The metrics.multiple array lists the multi-metric endpoints (custom-selection). Metric and dimension names are kebab-case, exactly as they appear in the request path. Use them with the templates in format. The full response also carries a parameters object (the accepted query parameters), a references array (the dimensions and filters lookup endpoints), and a resources array that lists every metric with its complete set of valid endpoint paths.

Note: Fetch this catalog once and reuse it. For a short definition of each metric, see the Metrics reference. To build efficient requests from these names, see Efficient API Usage.