Hanzo

Destinations

Package destinations is your events forwarded to the ad and analytics tools you use.

Package destinations is your events forwarded to the ad and analytics tools you use.

Base URLhttps://api.hanzo.ai
Operations5
AuthAuthorization: Bearer $HANZO_API_KEY

destinations

Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said.

POST /v1/destinations/{platform}/test

Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said. A send the platform refuses is reported as data — {"ok": false, "error": …} at 200 — so the console shows the platform's own words rather than an error about Hanzo. It requires org admin.

ParameterInTypeRequiredDescription
platformpathstringyesPlatform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | posthog | umami.

Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.

GET /v1/destinations/{platform}

Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now. A platform this deployment does not carry is not found.

ParameterInTypeRequiredDescription
platformpathstringyesPlatform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | posthog | umami.

post_v1_destinations_by_platform

POST /v1/destinations/{platform}

ParameterInTypeRequiredDescription
platformpathstringyes

Forgets a destination for the caller's org: every credential held in KMS, then the stored config.

DELETE /v1/destinations/{platform}

Forgets a destination for the caller's org: every credential held in KMS, then the stored config. Idempotent, and it requires org admin.

ParameterInTypeRequiredDescription
platformpathstringyesPlatform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | posthog | umami.

Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.

GET /v1/destinations

Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.


All Hanzo APIs · Interactive reference

How is this guide?

On this page