Hanzo
OpenapiDataroom

Record one page-view against an open viewing session

Appends a single per-page analytics event — {viewId, pageNumber, documentId, versionNumber, duration} — and answers with its id.

POST /v1/dataroom/view/{linkId}/pageview

Addresshttps://api.hanzo.ai/v1/dataroom/view/{linkId}/pageview
MethodPOST
Operationpost_dataroom_view_by_linkid_pageview
AuthAuthorization: Bearer $HANZO_API_KEY

Appends a single per-page analytics event — {viewId, pageNumber, documentId, versionNumber, duration} — and answers with its id. These events are what the owner's analytics count.

No principal: the viewId from the authenticate step IS the authorisation, and it must belong to THIS link or the call is 404, so a session opened on one link cannot write events onto another. pageNumber is required (400 without it); documentId falls back to the document the session was opened on, and duration is the caller's own dwell measure, summed per page by analytics.

Events are additive: the same page reported twice is two views, which is the metric's whole point.

Request

1 field.

FieldInTypeRequiredDescription
linkIdpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo dataroom view pageview <linkId>

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page