Hanzo
OpenapiMarketing

Evaluates the cohort LIVE — the same resolution an enrollment would run — and…

Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real mailboxes it reaches.

GET /v1/marketing/audiences/{id}/preview

Addresshttps://api.hanzo.ai/v1/marketing/audiences/{id}/preview
MethodGET
Operationget_marketing_audiences_by_id_preview
AuthAuthorization: Bearer $HANZO_API_KEY

Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real mailboxes it reaches. It is the honest answer to "is this send worth making": a cohort of 500 that mails 3 says so, in deliverable and unmatched. Nothing is sent.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the audience id from the path, as returned by create.

Response

StatusBodyMeaning
200AudiencePreviewok

200 body — 7 fields.

FieldInTypeAlwaysDescription
availablebodybooleanAvailable is false when the roster or the warehouse could not be read; the counts are then zero because nothing was measured, not because the cohort is empty,…
countbodyintegerCount is the cohort size: distinct warehouse identifiers for an event audience, mailable customers for an event-less (whole-org) one.
deliverablebodyintegerDeliverable is how many de-duplicated mailboxes a send would reach.
reasonbodystringReason is the error text of the read that failed: the org's roster could not be loaded ("identity store unavailable…"), or the cohort query had no warehouse to…
samplebodystring[]Sample is up to 1000 cohort IDENTIFIERS — never addresses, which product analytics does not hold.
sourcebodystringSource names where the cohort was read: the events table for an event audience, "iam:<org>" for the whole-org one.
unmatchedbodyintegerUnmatched is how many cohort identifiers named nobody on the org's roster and so have no address to mail.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing audiences preview <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page