---
title: "Retrieve metrics in a breakdown of dimensions"
method: GET
path: "/data/buckets/{metric}/{breakdown}"
tags: ["Analytics"]
---

# Retrieve metrics in a breakdown of dimensions

`GET /data/buckets/{metric}/{breakdown}`

Retrieve detailed analytics play-rate and number of impressions segmented by dimensions like country or device type.

## Path parameters

- `metric` 'play' | 'play-rate' | 'play-total' | 'start' | 'end' | 'impression' | 'ccv-peak' | 'ccv-average' | 'view', required
- `breakdown` 'media-id' | 'media-type' | 'continent' | 'country' | 'device-type' | 'operating-system' | 'browser' | 'referrer', required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `sortBy` 'metricValue' | 'dimensionValue'
- `sortOrder` 'asc' | 'desc'
- `unique` boolean
- `viewDuration` '3s' | '5s' | '10s' | '30s'
- `currentPage` integer
- `pageSize` integer

## Parameters

- `#/components/parameters/filterBy_2` — unresolved $ref

## Response `200`

Success

- AnalyticsMetricsBreakdownResponse
  - `context` AnalyticsMetricsBreakdownResponseContext, required
    - `metric` 'play' | 'play-rate' | 'start' | 'end' | 'impression' | 'ccv-average' | 'ccv-peak' | 'unique-ccv-average' | 'unique-ccv-peak' | 'view-3' | 'view-5' | 'view-10' | 'view-30' | 'unique-view' | 'unique-view-3' | 'unique-view-5' | 'unique-view-10' | 'unique-view-30' — Returns the metric and relevant parameters you selected.
    - `breakdown` 'media-id' | 'media-type' | 'continent' | 'country' | 'device-type' | 'operating-system' | 'browser' — Returns the dimension you selected.
    - `timeframe` AnalyticsAggregatedMetricsResponseContextTimeframe — Returns the starting and ending date-times of the period you want analytics for.
      - `from` string, date-time — Returns the starting date-time of the period you want analytics for in ATOM date-time format.
      - `to` string, date-time — Returns the starting date-time of the period you want analytics for in ATOM date-time format.
  - `data` AnalyticsMetricsBreakdownResponseData[], required — Returns an array of dimensions and their respective metrics.
    - `dimensionValue` string — Returns a specific value for the dimension you selected, based on the data. For example if you select `continent` as a dimension, then `dimensionValue` returns values like `EU` or "AZ".
    - `metricValue` number, float — Returns the data for a specific dimension value.
  - `pagination` Pagination, required
    - `itemsTotal` integer — Total number of items that exist.
    - `pagesTotal` integer — Number of items listed in the current page.
    - `pageSize` integer — Maximum number of item per page.
    - `currentPage` integer — The current page index.
    - `currentPageItems` integer — The number of items on the current page.
    - `links` PaginationLink[], required
      - `rel` string
      - `uri` string, uri

## Other responses

- `400` — Bad request error
- `404` — Unrecognized request URL
- `429` — Too Many Requests

---

[API](https://skmtc.net/apivideo/apis/api-video.md) · [All operations](https://skmtc.net/apivideo/apis/api-video/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apivideo/api-video/revisions/45ec26f342b6/schema)