Source: https://datafa.st/docs/api/website/breakdowns
Markdown source: https://datafa.st/docs/api/website/breakdowns.md
Description: Rank analytics by pages, referrers, countries, devices, browsers, campaigns, hostnames, and more.

# Breakdowns API

Use breakdown endpoints to rank dimensions and understand what drives traffic and revenue.

| Endpoint | Method | Path | Purpose |
|---|---|---|---|
| [Pages](/docs/api/website/breakdowns/pages) | GET | `/api/v1/analytics/pages` | Top pages by visitors, revenue, and payments |
| [Referrers](/docs/api/website/breakdowns/referrers) | GET | `/api/v1/analytics/referrers` | Traffic sources and referrers |
| [Countries](/docs/api/website/breakdowns/countries) | GET | `/api/v1/analytics/countries` | Countries |
| [Regions](/docs/api/website/breakdowns/regions) | GET | `/api/v1/analytics/regions` | Regions or states |
| [Cities](/docs/api/website/breakdowns/cities) | GET | `/api/v1/analytics/cities` | Cities |
| [Devices](/docs/api/website/breakdowns/devices) | GET | `/api/v1/analytics/devices` | Desktop, mobile, tablet |
| [Browsers](/docs/api/website/breakdowns/browsers) | GET | `/api/v1/analytics/browsers` | Browsers |
| [Operating systems](/docs/api/website/breakdowns/operating-systems) | GET | `/api/v1/analytics/operating-systems` | Operating systems |
| [Campaigns](/docs/api/website/breakdowns/campaigns) | GET | `/api/v1/analytics/campaigns` | UTM fields, ref, source, and via |
| [Hostnames](/docs/api/website/breakdowns/hostnames) | GET | `/api/v1/analytics/hostnames` | Hostnames |

All breakdown endpoints support common analytics parameters such as `startAt`, `endAt`, `timezone`, `limit`, `offset`, `fields`, and filters like `filter_country`, `filter_device`, `filter_page`, and `filter_goal`.

## Endpoint examples

```http
GET /api/v1/analytics/pages?limit=20&filter_country=is:United States
GET /api/v1/analytics/referrers?limit=20&startAt=2026-05-01&endAt=2026-05-19
GET /api/v1/analytics/countries?fields=country,visitors,revenue,payments
GET /api/v1/analytics/regions?filter_country=is:United States
GET /api/v1/analytics/cities?limit=50&filter_device=is:mobile
GET /api/v1/analytics/devices?fields=device,visitors,revenue,payments
GET /api/v1/analytics/browsers?filter_country=is:France
GET /api/v1/analytics/operating-systems?limit=20
GET /api/v1/analytics/campaigns?fields=utm_source,utm_medium,utm_campaign,visitors
GET /api/v1/analytics/hostnames?limit=20
```

## Revenue fields

Breakdown revenue is attribution data: it shows which pages, sources, countries, and devices influenced revenue. For full business totals, use [Analytics](/docs/api/website/analytics).

## Code examples

### Get top pages

```bash
curl -X GET "https://datafa.st/api/v1/analytics/pages?limit=20&filter_country=is:United%20States" \
  -H "Authorization: Bearer df_xxx"
```

### Success response

```json
{
  "status": "success",
  "data": [
    {
      "hostname": "example.com",
      "path": "/pricing",
      "visitors": 2150,
      "revenue": 8934,
      "payments": 96
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 243
  }
}
```