Estimating Broadcast Size

Graph API v2.11 Required

This API is available only in Graph API v2.11 and above.

There are times when it may be desirable to know the approximate number of people a broadcast message will be sent to before it is sent. To accomodate this, the Broadcast API offers reach estimation.

Due to the fact that reach estimation is a resource intensive process, it is executed in two steps. First, a reach estimation is started, then the result is retrieved.


Starting a Reach Estimation

To start a new reach estimation, send a POST request to the /broadcast_reach_estimations endpoint:

curl -X POST -k -H "Content-Type: application/json" '<PAGE_ACCESS_TOKEN>'

Optionally, to estimate the reach on a targeted broadcast, you may also send a custom_label_id in the body of the request:


Once the estimation has been initiated, the API will return a reach_estimation_id:

  "reach_estimation_id": <REACH_ESTIMATION_ID>

Retrieving a Reach Estimate

While the reach estimation process run, the API will continually update the estimate. For this reason, it is recommended that you wait 20 seconds to retrieve the result to ensure the result is acccurate.

To retrieve a reach estimate, send a GET request to the /<REACH_ESTIMATION_ID> endpoint:

curl -X GET -k -H "Content-Type: application/json" '<REACH_ESTIMATION_ID>?access_token=<PAGE_ACCESS_TOKEN>'

On success, the API will return the current reach estimate:

  "reach_estimation": "<REACH_ESTIMATE>"