Hanzo
OpenapiGuide

Suggest returns the caller org's next-best quests: the available, non-terminal…

Suggest returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each…

GET /v1/guide/suggest

Addresshttps://api.hanzo.ai/v1/guide/suggest
MethodGET
Operationget_guide_suggest
AuthAuthorization: Bearer $HANZO_API_KEY

Suggest returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each with the grounded reason it is a good next move and whether the Business AI can run it, plus the org's funnel and the GTM recommendations derived from it. A best-effort AI narrative over exactly those quests and numbers is included when an AI plane is wired. READ-ONLY: it advises and never runs a step — the only executing path is POST /v1/guide/steps/{id}/do.

Request

GET /v1/guide/suggest takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200suggestResponseok

200 body — 18 fields.

FieldInTypeAlwaysDescription
funnelbodyFunnel
funnel.availablebodybooleanAvailable separates "this org has no traffic" from "we could not ask".
funnel.ordersbodyintegerOrders counts completed orders in the window — purchases, not carts started.
funnel.pageviewsbodyintegerPageviews counts page events in the window, one per view rather than per person, so a single visitor reading ten pages counts ten.
funnel.revenuebodynumberRevenue is the sum of the amounts those orders reported, in whatever currency the beacon stamped on them (major units, e.g.
funnel.signupsbodyintegerSignups counts completed signups in the window, the step where an anonymous visitor becomes somebody with an account.
funnel.visitorsbodyintegerVisitors is the number of DISTINCT people seen in the window, counted by the beacon's distinct id — so it is unique visitors, not sessions and not views.
funnel.windowDaysbodyintegerWindowDays is the length of the trailing window every count covers, so a reader knows whether 40 signups is a month or a day.
narrativebodystringNarrative is the AI's grounded prose over those quests and numbers.
nextbodystringNext is the id of the single next step the static journey names — the linear answer the ranked Suggestions refine.
recommendationsbodystring[]Recommendations are the next-best GTM actions derived from that funnel.
suggestionsbodysuggestion[]Suggestions are the available, non-terminal quests ranked best-first by how much downstream work each unblocks.
suggestions[].automatablebodybooleanAutomatable is true when the step names a tool, so the Business AI can do it rather than only describe it.
suggestions[].detailbodystringDetail is the step's own prose — what it asks for.
suggestions[].rationalebodystringRationale is why this step is being suggested NOW, written for the person reading it.
suggestions[].stepIdbodystringStepID is the checklist step being recommended — the id every step route takes, so a caller can act on the suggestion directly.
suggestions[].titlebodystringTitle is the step's own one-line quest.
suggestions[].unlocksbodyintegerUnlocks is how many downstream steps completing this one immediately makes available (its leverage) — the primary ranking key.

Failure carries the platform error shape — see Errors.

Examples

hanzo guide suggest

Guide API · All Hanzo APIs · Interactive reference

How is this guide?

On this page