Hanzo
OpenapiDestination

Reports one destination's card for the caller's org — its config fields, its…

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/destination/{platform}

Addresshttps://api.hanzo.ai/v1/destination/{platform}
MethodGET
Operationget_destination_by_platform
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

1 field.

FieldInTypeRequiredDescription
platformpathstringyesPlatform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics.

Response

StatusBodyMeaning
200DestinationStatusok

200 body — 16 fields.

FieldInTypeAlwaysDescription
accountbodystringAccount is the operator's own label for the connected account, as supplied on connect.
categorybodystringgroups the card: Analytics | Advertising
configbodyobjectConfig is the org's stored NON-SECRET configuration — the measurement/pixel ids keyed by DestinationField.Key.
config.*bodystring
connectedbodybooleanConnected is true when this org has a stored row for the platform — it has been configured here at least once.
enabledbodybooleanEnabled is whether the fan-out forwards to this destination.
fieldsbodyDestinationField[]Fields are the non-secret inputs this platform needs, which the console card renders and the connect body fills.
fields[].examplebodystringa sample value of the right shape ("G-XXXXXXX"), when one helps
fields[].keybodystringthe camelCase key on both the connect body and the stored config
fields[].labelbodystringhuman label for the console card's input
fields[].requiredbodybooleanwhen true, a connect that leaves it empty is refused 400
livebodybooleanLive is whether a credential resolves RIGHT NOW: a KMS-sealed secret for this org, else the integrations connection named by the platform's Fallback, else no…
namebodystringthe platform's display name ("Google Analytics 4")
pixelbodybooleanPixel is whether the hosted tag can inject a browser pixel for this platform, so a console offers a per-SITE pixel input for exactly these.
platformbodystringthe platform slug, and the path segment every route addresses it by
secretsbodystring[]Secrets are the KMS secret NAMES this platform custodies for the org — names only, never values.

Failure carries the platform error shape — see Errors.

Examples

hanzo destinations get <platform>

Destination API · All Hanzo APIs · Interactive reference

How is this guide?

On this page