VantageKitVantageKit Docs

List viewers

Returns a paginated list of unique viewers for a deal room with aggregated engagement data. Viewers are sorted by most recent view. Each viewer profile includes total views, time spent, and documents viewed.

GET
/deal-rooms/{id}/viewers

Authorization

AuthorizationBearer <token>

Pass your API key as a Bearer token.

Authorization: Bearer vk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345

In: header

Path Parameters

id*string

Deal room UUID.

Formatuuid

Query Parameters

page?integer

Page number (1-indexed).

Default1
Range1 <= value
per_page?integer

Items per page (max 100).

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vantagekit.com/v1/deal-rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08/viewers"
{
  "data": [
    {
      "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
      "email": "jane@acme.com",
      "name": "Jane Smith",
      "firstViewedAt": "2026-03-20T09:00:00Z",
      "lastViewedAt": "2026-04-07T16:30:00Z",
      "totalViews": 8,
      "totalDurationSeconds": 420,
      "documentsViewed": 3,
      "linkName": "Investor Link"
    }
  ],
  "meta": {
    "apiVersion": "2026-04-01",
    "pagination": {
      "page": 1,
      "perPage": 20,
      "total": 8,
      "totalPages": 1
    }
  }
}
{
  "error": "API key is required",
  "code": "unauthorized"
}
{
  "error": "Deal room not found",
  "code": "not_found"
}
{
  "error": "Rate limit exceeded",
  "code": "rate_limit"
}
{
  "error": "An unexpected error occurred",
  "code": "internal_error"
}

List links

Returns a paginated list of share links for a deal room, sorted by most recently created. Password hashes are never exposed — only a `requiresPassword` boolean is returned.

Get analytics

Returns aggregated analytics for a deal room over a specified time period. Includes total views, unique viewers, average duration, top documents, top links, and a daily views timeline.