Get Campaign Recipient Estimation

GET {{baseUrl}}/api/campaign-recipient-estimations/:id/

Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the Create Campaign Recipient Estimation Job endpoint.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes: campaigns:read

Request Params

KeyDatatypeRequiredDescription
fields[campaign-recipient-estimation]stringFor more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{"data":{"type":"campaign-recipient-estimation","id":"\u003cstring\u003e","attributes":{"estimated_recipient_count":"\u003cinteger\u003e"},"links":{"self":"\u003curi\u003e"}}}