Hanzo
OpenapiDataroom

Reports how one share link was actually read: total viewing sessions, total…

Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count, the summed dwell measure and its…

GET /v1/dataroom/analytics/link/{linkId}

Addresshttps://api.hanzo.ai/v1/dataroom/analytics/link/{linkId}
MethodGET
Operationget_dataroom_analytics_link_by_linkid
AuthAuthorization: Bearer $HANZO_API_KEY

Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count, the summed dwell measure and its average.

The link is resolved in the caller's OWN tenant store, so another org's link id is not found — knowing a link id is enough to OPEN the room it shares, and never enough to read who has been reading it.

Request

1 field.

FieldInTypeRequiredDescription
linkIdpathstringyesLinkID is the link to report on.

Response

StatusBodyMeaning
200dataroomLinkStatsok

200 body — 8 fields.

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

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom analytics link get <linkId>

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page