Sign inGet Started

Estimate marketing reach for a maximum price

GET
/v1/whatsapp/business-accounts/{business_account_ref}/reach-estimate
bird whatsapp business-accounts reach-estimate <business-account-ref>
Reactie200
{
  "currency_code": "EUR",
  "estimates": [
    {
      "bid_amount": 2590,
      "users": 1000,
      "deliveries_lower_bound": 67,
      "deliveries_upper_bound": 267,
      "cost_lower_bound": 1940.6530830145,
      "cost_upper_bound": 2590
    }
  ]
}

Returns Meta's estimate of how many marketing deliveries, and at what cost, each candidate maximum price would have won over window. Use it to choose a template language's optimization_spec.bid_amount.

Every amount is per 1,000 deliveries, in the smallest unit of currency_code. Estimates come from Meta's recent auctions and are not a guarantee. Bird asks Meta on every request and stores nothing.

Every country must support a maximum price. One that does not fails the whole request with E15090. WhatsApp does not say which country, so estimate the countries one at a time to find it.

Parameters

business_account_refstring

WhatsApp Business Account ID (waa_ prefix) or the WhatsApp Business Account ID Meta reports in waba. A value that parses as a valid ID resolves by ID; any other value resolves as Meta's ID.

Queryparameters

countriesarray

The recipients' countries, as ISO 3166-1 alpha-2 codes. Repeat the parameter for several.

windowstring

The days of recent auctions the estimate is based on, ending now. Omit it to use the last 7 days.

Possible values: 1d, 7d, 14d, 28d

Response Payload

currency_code
string
verplicht

The currency of every amount in estimates.

estimates
array of object
verplicht

One estimate per candidate bid, in ascending bid order.

Onderliggende attributen tonen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.