Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

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>
Réponse200
{
  "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.

Meta estimates one country per request, so countries takes exactly one; request each country separately. A country that does not support a maximum price fails with E15090.

Paramètres

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.

Paramètres de requête

countriesarray

The recipients' country, as an ISO 3166-1 alpha-2 code. Exactly one, because Meta refuses an estimate for more than one country.

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

Contenu de la réponse

currency_code
string
obligatoire

The currency of every amount in estimates.

estimates
array of object
obligatoire

One estimate per candidate bid, in ascending bid order.

Afficher les attributs enfants
estimates.bid_amount
integer
obligatoire

The candidate bid, per 1,000 deliveries in the smallest currency unit. It is the unit optimization_spec.bid_amount takes.

estimates.users
integer
obligatoire

The audience size the estimate is for.

estimates.deliveries_lower_bound
integer
obligatoire
estimates.deliveries_upper_bound
integer
obligatoire
estimates.cost_lower_bound
number
obligatoire

The lower cost estimate, per 1,000 deliveries in the smallest currency unit.

estimates.cost_upper_bound
number
obligatoire

The upper cost estimate, per 1,000 deliveries in the smallest currency unit.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation