Hanzo
OpenapiMarketing

Returns the org's saved audiences, most recently updated first.

Returns the org's saved audiences, most recently updated first.

GET /v1/marketing/audiences

Addresshttps://api.hanzo.ai/v1/marketing/audiences
MethodGET
Operationget_marketing_audiences
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's saved audiences, most recently updated first.

Request

1 field.

FieldInTypeRequiredDescription
limitqueryintegerLimit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Response

StatusBodyMeaning
200AudienceListok

200 body — 7 fields.

FieldInTypeAlwaysDescription
databodyAudience[]Data is the page; an empty array when the org has saved no audience.
data[].createdAtbodyintegerCreatedAt is unix seconds when the filter was saved, server-assigned.
data[].eventbodystringEvent is the analytics event a member must have fired.
data[].idbodystringID is the server-assigned audience id ("aud_" + 128 random bits).
data[].namebodystringName is the audience's label.
data[].updatedAtbodyintegerUpdatedAt is unix seconds of the last write, server-assigned, and the key the audience list is ordered by (newest first).
data[].windowDaysbodyintegerWindowDays is how far back the event counts, ending now.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing audiences list

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page