Hanzo
OpenapiDataroom

Rolls up every share link pointing at one data room: session and page-view…

Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page breakdown for each link beneath it.

GET /v1/dataroom/analytics/dataroom/{dataroomId}

Addresshttps://api.hanzo.ai/v1/dataroom/analytics/dataroom/{dataroomId}
MethodGET
Operationget_dataroom_analytics_dataroom_by_dataroomid
AuthAuthorization: Bearer $HANZO_API_KEY

Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page breakdown for each link beneath it.

A room id outside the caller's own tenant store is not found. Only links that NAME the room are counted — a link created over a single document contributes nothing here, even when that document also sits in the room.

Request

1 field.

FieldInTypeRequiredDescription
dataroomIdpathstringyesDataroomID is the room to report on.

Response

StatusBodyMeaning
200dataroomStatsok

200 body — 12 fields.

FieldInTypeAlwaysDescription
dataroomIdbodystringDataroomId is the room these counts are for.
linksbodydataroomLinkStats[]Links is the same per-page breakdown for each link into the room.
links[].linkIdbodystringLinkId is the link these counts are for.
links[].pagesbodydataroomPageStat[]Pages is the per-page breakdown, in page order.
links[].pages[].avgDurationbodyintegerAvgDuration is totalDuration divided by views, rounded; 0 when unviewed.
links[].pages[].pageNumberbodyintegerPageNumber is the page these counts are for.
links[].pages[].totalDurationbodyintegerTotalDuration is the summed dwell measure reported for the page.
links[].pages[].viewsbodyintegerViews is how many times the page was viewed.
links[].totalPageViewsbodyintegerTotalPageViews is how many page views the link received.
links[].totalViewsbodyintegerTotalViews is how many viewing sessions the link opened.
totalPageViewsbodyintegerTotalPageViews is the room's page views across every link.
totalViewsbodyintegerTotalViews is the room's viewing sessions across every link.

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom analytics dataroom get <dataroomId>

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page