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
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[campaign-recipient-estimation] | string | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":{"type":"campaign-recipient-estimation","id":"\u003cstring\u003e","attributes":{"estimated_recipient_count":"\u003cinteger\u003e"},"links":{"self":"\u003curi\u003e"}}}