Hanzo
OpenapiMarketing

Returns one of the caller org's saved audiences.

Returns one of the caller org's saved audiences.

GET /v1/marketing/audiences/{id}

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

Returns one of the caller org's saved audiences. An audience belonging to another org reads as not found.

Request

1 field.

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

Response

StatusBodyMeaning
200Audienceok

200 body — 6 fields.

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

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing audiences get <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page