Documents

List the views of a document

GET/documents/{document_id}/views
documents:readlist_document_viewsRead-only

Lists who viewed or downloaded a document, newest first, one page at a time. Each row is one access: a download or image link issued through the API, or the file added to a zip download. Needs the permission to manage user documents on the token's user, else 403 missing_permission; a document the token cannot read returns 404. Add totals=true or group_by=user_id for counts, and filter[user_type]=investor for investor-only figures. It changes nothing.

Path parameters

  • document_idstring (uuid)Required#

    The document's id.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: created_at. Prefix a field with - for descending. Defaults to -created_at. The id is always the final tiebreak.

  • totalsboolean#

    Send true to add view and download counts, distinct users and the last access, across every match, to meta.totals. Sending group_by also turns totals on.

  • group_bystring#

    Comma-separated fields to split the totals by, giving one row per combination that has views. Any of user_id.

  • filter[user_id]string (uuid)#

    Views by this user. Takes [in] and [not_in] with a comma-separated list.

  • filter[intent]string#

    Only views, or only downloads. Takes [in] and [not_in] with a comma-separated list.

    One of: view, download
  • filter[created_at]string#

    Only accesses in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

  • filter[user_type]string#

    Only accesses by users of this kind: investor, internal (staff) or entrepreneur. Send investor for investor-only figures. Takes [in] and [not_in] with a comma-separated list; users who no longer exist match only [not_in].

    One of: investor, internal, entrepreneur

Responses

200

The views.

DocumentViewListWithTotals
{
  "data": [
    {}
  ],
  "meta": {
    "totals": [
      {}
    ]
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/documents/{document_id}/views\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"