Engagement by location
GET
/v1/email/stats/locations
curl -X GET "https://us1.platform.bird.com/v1/email/stats/locations" \
-H "Authorization: Bearer $TOKEN" \
--url-query "group_by=country" \
--url-query "sort=unique_opens" \
--url-query "limit=50"Returns engagement counts (opens and clicks) grouped by the location they were recorded from, for the requested period. Use it to see where your audience engages -- for example the top countries by unique opens.
Location comes from open and click events only, so this breakdown reports engagement activity, not delivery: it has no delivery counts and no open/click rates, because delivery is reported by the receiving mail server without a recipient location and there is therefore no per-location delivered denominator.
Use group_by to choose the granularity: country (default), region, or city. Each row carries the location hierarchy down to the requested level (a city grouping also reports the row's region and country). Rows are ranked by the sort metric (default unique_opens) descending and capped at the requested limit (default 50, hard maximum 200).
Rows are computed against event time (not send time). The maximum window is 365 days; requesting a longer range returns 422.
Paramètres de requête
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 (for example Asia/Kathmandu or America/New_York) to report the statistics in. It is the single source of timezone: day and hour boundaries, and the relative window defaults used when from and to are omitted, are computed in this timezone instead of UTC, so a timezone with a sub-hour offset (such as India at +05:30 or Nepal at +05:45) still gets correct local-day and local-hour totals. When it is set, a from or to given as a calendar day names a local day in this timezone, and one given as an instant stays an absolute point in time but is rounded down to its hour and bucketed in this timezone (so the hour boundaries are local, not UTC). To avoid specifying the zone twice, a from or to that carries its own numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant instead. Defaults to UTC.
category
string
Email statistics are aggregated across all categories. Per-category filtering is not yet available; supplying this parameter returns 422.
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.
sort
string
Metric to rank rows by, applied descending. Defaults to unique_opens. Only engagement counts are sortable; this breakdown has no rates.
limit
integer
Maximum number of location rows to return, ranked by the sort field descending.
Contenu de la réponse
period
object
obligatoire
Afficher les attributs enfants
period.from
string
obligatoire
Inclusive start date the response covers (YYYY-MM-DD).
period.to
string
obligatoire
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 is near-real-time but not live; 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
obligatoire
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.
Afficher les attributs enfants
data.country
string
obligatoire
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
obligatoire
The region (state or province) within the country. Populated when group_by is region or city; null at coarser groupings.
data.city
nullable string
obligatoire
The city within the region. Populated when group_by is city; null at coarser groupings.
data.engagement
object
obligatoire
Afficher les attributs enfants
data.engagement.opens
integer
obligatoire
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
obligatoire
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
obligatoire
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
data.engagement.unique_opens_non_prefetched
integer
obligatoire
Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features.
data.engagement.clicks
integer
obligatoire
Distinct click events, counting repeat clicks from the same recipient.
data.engagement.unique_clicks
integer
obligatoire
Distinct recipients who clicked at least once.
total
integer
obligatoire
Total number of distinct locations at the requested group_by level with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.