Analytics

List the people who viewed a deal

GET/analytics/reports/deal-viewers
analytics:readlist_deal_viewer_rowsRead-only

Lists the users who interacted with one deal (viewed, enquired, asked, favourited, gave feedback or committed), with their counts. filter[deal_id] is required; without it the call is 422 validation_failed (field: "filter", rule: "required"). An invisible or unknown deal gives an empty list, not a 404. Entrepreneurs and deleted users are left out; rows are users of any organisation who interacted with a deal the caller can see; names and amounts are visible to the deal's viewers. Settled events are not engagements or enquiries. It only reads.

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: name, views, last_viewed_at, engagements or committed_amount. Prefix a field with - for descending. Defaults to -last_viewed_at. A user who never viewed the deal sorts as the oldest viewer.

  • filter[deal_id]string (uuid)Required#

    The deal whose viewers to list, as GET /deals returns its id. Takes one id; [in] and [not_in] are 422.

  • filter[type]string#

    Only users of this kind: User (an investor), Internal User or Advisor. Takes [in] and [not_in] with a comma-separated list.

    One of: User, Internal User, Advisor
  • filter[last_viewed_at]string (date-time)#

    Only users who last viewed the deal in a range, written filter[last_viewed_at][gte]=2026-10-01. Takes gt, gte, lt and lte. A user who never viewed it never matches.

Responses

200

One page of viewer rows.

DealViewerRow[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "type": "User",
      "views": 1,
      "first_viewed_at": "2026-06-12T10:00:00+00:00",
      "last_viewed_at": "2026-06-12T10:00:00+00:00",
      "engagements": 1,
      "enquiries": 1,
      "commitments": 1,
      "committed_amount": 1
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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
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/analytics/reports/deal-viewers?filter[deal_id]={filter[deal_id]}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"