---
title: "Break down visitors by acquisition channel"
method: GET
path: "/channels"
tags: ["Breakdowns"]
---

# Break down visitors by acquisition channel

`GET /channels`

## Request

- Base URL: `https://analytics.flowsery.com/analytics/api/v1`
- URL: `https://analytics.flowsery.com/analytics/api/v1/channels`
- Auth: HTTP bearer

Organic search, paid, social, referral, direct and email, ordered by visitors.

## Query parameters

- `websiteId` string
- `domain` string
- `startAt` string, date-time
- `endAt` string, date-time
- `timezone` string
- `limit` integer
- `offset` integer
- `filter_country` string
- `filter_region` string
- `filter_city` string
- `filter_device` string
- `filter_browser` string
- `filter_os` string
- `filter_referrer` string
- `filter_ref` string
- `filter_source` string
- `filter_via` string
- `filter_utm_source` string
- `filter_utm_medium` string
- `filter_utm_campaign` string
- `filter_utm_term` string
- `filter_utm_content` string
- `filter_page` string
- `filter_hostname` string
- `filter_entry_page` string
- `filter_channel` string
- `filter_goal` string

## Headers

- `X-Workspace-Id` string

## Response `200`

Breakdown rows ordered by visitors, descending.

- BreakdownResponse
  - `status` 'success', required
  - `data` BreakdownRow[], required
    - `value` string, required: `Unknown` when the attribute was not captured.
    - `visitors` integer, required
    - `revenue` number
    - `newRevenue` number
    - `renewalRevenue` number
    - `percentage` number: This row’s share of visitors in the window, 0-100.
    - `countryCode` string: ISO 3166-1 alpha-2, present on geographic dimensions.
    - `iconUrl` string, nullable: Favicon of the referring site, present on the referrer dimension.
  - `pagination` Pagination
    - `limit` integer, required
    - `offset` integer, required
    - `total` integer, required: Total rows matching the query, before paging.

## Other responses

- `401`: Missing, invalid, expired or revoked API key or access token. `code: token_issuer_lost_access` means the member who created the API key was deactivated or lost access to the workspace: ask a workspace admin for a new key
- `403`: The credentials are valid but cannot be used here. `code: permission_denied`: the workspace role behind the API key or OAuth sign-in lacks `flowsery.write`; `role`, `keyRole` and `issuerRole` say which role fell short. `code: subscription_required`: the organization plan does not include API access. `code: workspace_access_denied`: `X-Workspace-Id` names a workspace the caller cannot reach, or an API key was sent to a workspace other than its own
- `404`: Website not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api.md) · [All operations](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/revisions/8f23583fdf0e?raw)