CLIDataroom
Dataroom
17 `hanzo` commands for Dataroom, each calling one operation on api.hanzo.ai.
Package dataroom is a secure document room you share by link and watch page by page.
17 commands · API reference →
| Command | Calls | What it does |
|---|---|---|
hanzo dataroom analytics dataroom get <dataroomId> | GET /v1/dataroom/analytics/dataroom/{dataroomId} | Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page… |
hanzo dataroom analytics link get <linkId> | GET /v1/dataroom/analytics/link/{linkId} | Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count,… |
hanzo dataroom datarooms documents <id> | POST /v1/dataroom/datarooms/{id}/documents | Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id. |
hanzo dataroom datarooms get <id> | GET /v1/dataroom/datarooms/{id} | Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order… |
hanzo dataroom datarooms list | GET /v1/dataroom/datarooms | Returns every data room in the caller org's own store, newest first, with its short public id, name, description and… |
hanzo dataroom datarooms create | POST /v1/dataroom/datarooms | Opens a new data room for the caller org and answers with it, including the short public id it is addressed by. |
hanzo dataroom documents file <id> | GET /v1/dataroom/documents/{id}/file | Download a document's bytes as its owner |
hanzo dataroom documents get <id> | GET /v1/dataroom/documents/{id} | Reads one of the caller org's documents — its name, opaque storage key, content type, page count, size and timestamps. |
hanzo dataroom documents list | GET /v1/dataroom/documents | Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page… |
hanzo dataroom documents create | POST /v1/dataroom/documents | Upload a document's bytes and record it |
hanzo dataroom health | GET /v1/dataroom/health | Liveness of the dataroom subsystem |
hanzo dataroom links get | GET /v1/dataroom/links | Returns every live share link in the caller org's own store, newest first, with the controls a visitor will meet:… |
hanzo dataroom links create | POST /v1/dataroom/links | Grants access: it mints a public share link over one data room (dataroomId) or one document (documentId) — one of… |
hanzo dataroom view authenticate <linkId> | POST /v1/dataroom/view/{linkId}/authenticate | Pass a share link's gates and open a viewing session |
hanzo dataroom view document file <linkId> <documentId> | GET /v1/dataroom/view/{linkId}/document/{documentId}/file | Read a document's bytes as an authorised link visitor |
hanzo dataroom view pageview <linkId> | POST /v1/dataroom/view/{linkId}/pageview | Record one page-view against an open viewing session |
hanzo dataroom view get <linkId> | GET /v1/dataroom/view/{linkId} | What a share link's visitor sees before authenticating |
How is this guide?