---
title: "Get engagement by location"
canonical: "https://bird.com/docs/api/reference/get-email-stats-by-location"
---

# Get engagement by location

`GET /v1/email/stats/locations`

Returns engagement counts (opens and clicks) for the requested period, grouped by the location they were recorded from. Use it to see where your audience engages, for example the top countries by unique opens. The reading location is only known from open and click events, so rows have engagement counts but no delivery counts or rates.

Use `group_by` to choose the granularity: `country` (the default), `region`, or `city`. Each row has the location hierarchy down to the requested level, so a `city` grouping also reports that row's region and country. Rows are ranked by the `sort` metric, `unique_opens` by default, and paginated with the requested `limit` (50 by default, 200 at most).

Rows are computed against event time rather than send time. The window can span at most 365 days. Ask for more and you get a `422`.

## Code samples

**TypeScript**

```ts
const { data } = await bird.email.stats.byLocation({
  from: "2026-05-01",
  to: "2026-05-31",
  limit: 25,
});
for (const row of data) console.log(row.country, row.engagement.unique_opens);
```

Examples: [TypeScript](/docs/api/reference/get-email-stats-by-location.ts.md) · [Python](/docs/api/reference/get-email-stats-by-location.py.md) · [Go](/docs/api/reference/get-email-stats-by-location.go.md) · [PHP](/docs/api/reference/get-email-stats-by-location.php.md) · [CLI](/docs/api/reference/get-email-stats-by-location.cli.md) · [MCP](/docs/api/reference/get-email-stats-by-location.mcp.md) · [cURL](/docs/api/reference/get-email-stats-by-location.curl.md)

## Example response `200`

```json
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621
      }
    }
  ],
  "total": 86,
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
```

## Query parameters

- `starting_after` (string): Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
- `ending_before` (string): Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
- `from` (string): Start date (inclusive) in `YYYY-MM-DD`, interpreted as a calendar day in `timezone` (a UTC day when `timezone` is omitted). Defaults to 30 days before `to` when omitted.
- `to` (string): End date (inclusive) in `YYYY-MM-DD`, interpreted as a calendar day in `timezone` (a UTC day when `timezone` is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.
- `timezone` (string): IANA timezone identifier used to group statistics, for example `Asia/Kathmandu`. The default is UTC. Day and hour boundaries, including the default window when `from` and `to` are omitted, follow this timezone. When this parameter is set, pass `from` and `to` as calendar days or `Z` instants instead of timestamps with explicit UTC offsets.
- `category` (string): Not supported on breakdown endpoints; supplying it returns `422`. To compare categories use `GET /v1/email/stats/categories`; the summary, daily, and hourly statistics accept `category` as a filter.
- `group_by` (string)

  Location granularity for each row. `country` (default) groups by country; `region` groups by region within country; `city` groups by city within region. Each row reports the location hierarchy down to the chosen level.

  Possible values: `country`, `region`, `city`
- `sort` (string)

  Metric to rank rows by, applied descending. It defaults to `unique_opens`. Only engagement counts are sortable. This breakdown has no rates.

  Possible values: `opens`, `opens_non_prefetched`, `unique_opens`, `unique_opens_non_prefetched`, `clicks`, `unique_clicks`
- `limit` (integer): Maximum number of location rows to return, ranked by the `sort` field descending.

## Response body

- `period` (object, required): The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
- `period.from` (string, required): Inclusive start date the response covers (YYYY-MM-DD).
- `period.to` (string, required): Inclusive end date the response covers (YYYY-MM-DD).
- `period.data_as_of` (nullable string): The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response reflects data from up to a few seconds ago. Use this field to label data freshness (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
- `data` (array of object, required): Location breakdown rows, ranked by the `sort` metric (default `unique_opens`) descending. Empty when no opens or clicks with a resolved location occurred in the period.
- `data.country` (string, required): The country this row aggregates, as a two-letter country code (ISO 3166-1 alpha-2) resolved from the open or click event. Always present.
- `data.region` (nullable string, required): The region (state or province) within the country. Populated when `group_by` is `region` or `city`; null at coarser groupings.
- `data.city` (nullable string, required): The city within the region. Populated when `group_by` is `city`; null at coarser groupings.
- `data.engagement` (object, required)
- `data.engagement.opens` (integer, required): Distinct open events, counting repeat opens from the same recipient and opens auto-fetched by inbox privacy features (such as Apple Mail Privacy Protection and the Gmail image proxy).
- `data.engagement.opens_non_prefetched` (integer, required): Distinct open events excluding those auto-fetched by inbox privacy features. Same event-counting semantics as `opens`, with prefetched opens removed.
- `data.engagement.unique_opens` (integer, required): Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
- `data.engagement.unique_opens_non_prefetched` (integer, required): Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features.
- `data.engagement.clicks` (integer, required): Distinct click events, counting repeat clicks from the same recipient.
- `data.engagement.unique_clicks` (integer, required): Distinct recipients who clicked at least once.
- `total` (integer, required): Total number of distinct locations at the requested `group_by` level with activity in the period, regardless of `limit`. Pass `next_cursor` as `starting_after` to request the next page.
- `next_cursor` (nullable string, required): Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
- `prev_cursor` (nullable string, required): Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
- `refresh_cursor` (nullable string, required): Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Related resources

- [What is click-through rate for email and SMS?](/explained/engagement/what-is-click-through-rate) (answer)
- [Email analytics](/email-api/features/analytics) (product)
- [Email metrics](/docs/guides/email/tracking-and-metrics) (docs)

[Get an implementation brief](/learn/workspace?topic=email-metrics)