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.
AuthorizationBearer <token>
Pass your API key as a Bearer token.
Authorization: Bearer vk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345
In: header
Path Parameters
id*string
Deal room UUID.
Format
uuidQuery Parameters
period?string
Time period for analytics aggregation.
7d— Last 7 days30d— Last 30 days (default)90d— Last 90 daysall— All time
Default
"30d"Value in
"7d" | "30d" | "90d" | "all"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/analytics"{
"data": {
"dealRoomId": "550e8400-e29b-41d4-a716-446655440000",
"period": "30d",
"totalViews": 23,
"uniqueViewers": 8,
"avgViewDurationSeconds": 145,
"totalDownloads": 5,
"topDocuments": [
{
"documentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Pitch Deck Q4",
"views": 15,
"avgDurationSeconds": 180
}
],
"topLinks": [
{
"linkId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Investor Link",
"clicks": 47
}
],
"viewsOverTime": [
{
"date": "2026-04-01",
"views": 3
},
{
"date": "2026-04-02",
"views": 5
}
]
},
"meta": {
"apiVersion": "2026-04-01"
}
}{
"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"
}