---
title: "Breakdown"
method: GET
path: "/sites/{site}/breakdowns/{dimension}"
tags: ["Analytics"]
---

# Breakdown

`GET /sites/{site}/breakdowns/{dimension}`

## Request

- Base URL: `https://api.onelence.com/v1`
- URL: `https://api.onelence.com/v1/sites/{site}/breakdowns/{dimension}`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.onelence.com/oauth/authorize`, token URL `https://api.onelence.com/oauth/token`, scopes: `analytics:read`)
  - HTTP bearer

Visitors and conversions split by one dimension (source, channel, campaign, keyword, affiliate, entry/landing page, page, hostname, country, region, city, device, browser, os), largest first. Row names can be used as filter_value with that dimension. A visitor counts in every row they appear in, so rows can add up to more than the site's visitors. compare=previous_period adds each row's previous-period values.

## Path parameters

- `site` string, required
- `dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device', required

## Query parameters

- `start` string
- `end` string
- `filter_dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device'
- `filter_value` string
- `compare` 'none' | 'previous_period'
- `limit` integer
- `cursor` string

## Response `200`

Success.

- object
  - `object` 'list', required
  - `data` object[], required
    - `name` string, required
    - `channel` string, nullable
    - `visitors` number, nullable, required
    - `conversions` number, nullable, required
    - `previous_visitors` number, nullable
    - `visitors_change_pct` number, nullable
    - `previous_conversions` number, nullable
    - `conversions_change_pct` number, nullable
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required
  - `note` string, required
  - `site` object, required
    - `id` string, required
    - `domain` string, required
  - `window` object, required
    - `start` string, nullable, required
    - `end` string, nullable, required
  - `dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device', required
  - `filter` object, nullable, required
    - `dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device', required
    - `value` string, required
  - `names_hidden` boolean, required
  - `comparison` object, nullable, required
    - `window` object, required
      - `start` string, nullable, required
      - `end` string, nullable, required

## Other responses

- `400`: Invalid input; `error.param` names the field.
- `401`: Missing, expired or revoked token. WWW-Authenticate points to the resource metadata.
- `402`: subscription_required or upgrade_required; the error carries billing_url.
- `403`: insufficient_scope or admin_required.
- `404`: Unknown endpoint, site, source or record.
- `429`: Rate limited. Retry after Retry-After seconds.
- `500`: OneLence could not complete the request.

---

[API](https://skmtc.dev/onelence/apis/onelence-api.md) · [All operations](https://skmtc.dev/onelence/apis/onelence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onelence/apis/onelence-api/revisions/971c72fe9a42?raw)