email-audiences

Get audience membership statistics

Returns the first successful observation for each requested UTC date, in chronological order. Changes between observations are unobserved. A missing observation has null total and observed_at; a successful empty audience has zero members. History retains today and the preceding 364 UTC dates; older requested dates are gaps. No history is reconstructed before observation began.

Only daily UTC observations are supported. Period data_as_of is always null because samples do not establish continuous freshness; each point carries its actual observed_at. Future, reversed, invalid or longer-than-365-date windows return 422. For the current exact count, use Get audience membership.

Returns 421 when the workspace's organization is served from a different region from the API host. Retry against that workspace's regional host.

get/v1/audiences/{audience_id}/membership-statistics

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/audiences/{audience_id}/membership-statistics
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

audience_idstring required
Example:adn_01krdgeqcxet5s7t44vh8rt9mg

ID of the audience whose observations to read.

Query parameters

fromstring date

Inclusive first UTC date. Defaults to 30 days before to, yielding 31 inclusive dates.

tostring date

Inclusive last UTC date. Defaults to today in UTC; future dates are rejected. At most 365 inclusive dates.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Daily membership observations for the requested period.

Changes

No recorded changes to this operation across all 2 revisions of this API.