View Analytics
Customize Behavior
Get Started
- Overview
- Quickstart
- Setup
Key Concepts
- Overview
- Organizations
- Documents
- Locations
- Users
- Access Control
Async Collaboration
- Comments
- In-app Notifications
- Inline Reactions
- Recorder
- View Analytics
- Arrows
Realtime Collaboration
- Presence
- Cursors
- Follow Me Mode
- Huddle
- Live Selection
- Live State Sync
- Single Editor Mode
- Video Player Sync
Email Notifications
Miscellaneous
- Migrate From Cord
- Common Integration Questions
View Analytics
Customize Behavior
getUniqueViewsByUser
- Get unique views by user.
- You can optionally filter by location.
Props:
<VeltViewAnalytics />
// or
<VeltViewAnalytics type="location" location-id="MY_LOCATION_ID" />
Using Hooks:
const viewsByUser = useUniqueViewsByUser();
const viewsByUserForLocation = useUniqueViewsByUser('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by user
let subscription = viewsElement.getUniqueViewsByUser().subscribe((viewsByUser) => {
console.log('Unique views by user: ', viewsByUser);
});
// you can optionally pass client-location-id to get unique views by users for that location
let subscription = viewsElement.getUniqueViewsByUser('your-location-id').subscribe((viewsByUser) => {
console.log('Unique views by date for location: ', viewsByUser);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
Props:
<VeltViewAnalytics />
// or
<VeltViewAnalytics type="location" location-id="MY_LOCATION_ID" />
Using Hooks:
const viewsByUser = useUniqueViewsByUser();
const viewsByUserForLocation = useUniqueViewsByUser('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by user
let subscription = viewsElement.getUniqueViewsByUser().subscribe((viewsByUser) => {
console.log('Unique views by user: ', viewsByUser);
});
// you can optionally pass client-location-id to get unique views by users for that location
let subscription = viewsElement.getUniqueViewsByUser('your-location-id').subscribe((viewsByUser) => {
console.log('Unique views by date for location: ', viewsByUser);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
Props:
<velt-view-analytics></velt-view-analytics>
<!-- or -->
<velt-view-analytics
type="location"
location-id="your-location-id">
</velt-view-analytics>
Using Hooks:
const viewsByUser = useUniqueViewsByUser();
const viewsByUserForLocation = useUniqueViewsByUser('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by user
let subscription = viewsElement.getUniqueViewsByUser().subscribe((viewsByUser) => {
console.log('Unique views by user: ', viewsByUser);
});
// you can optionally pass client-location-id to get unique views by users for that location
let subscription = viewsElement.getUniqueViewsByUser('your-location-id').subscribe((viewsByUser) => {
console.log('Unique views by date for location: ', viewsByUser);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
getUniqueViewsByDate
- Get unique views by date.
- You can optionally filter by location.
Props:
<VeltViewAnalytics />
// or
<VeltViewAnalytics type="location" location-id="MY_LOCATION_ID" />
Using Hooks:
const viewsByDate = useUniqueViewsByDate();
const viewsByDateForLocation = useUniqueViewsByDate('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by date
let subscription = viewsElement.getUniqueViewsByDate().subscribe((viewsByDate) => {
console.log('Unique views by date: ', viewsByDate);
});
// you can optionally pass client-location-id to get unique views by date for that location
let subscription = viewsElement.getUniqueViewsByDate('your-location-id').subscribe((viewsByDate) => {
console.log('Unique views by date for location: ', viewsByDate);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
Props:
<VeltViewAnalytics />
// or
<VeltViewAnalytics type="location" location-id="MY_LOCATION_ID" />
Using Hooks:
const viewsByDate = useUniqueViewsByDate();
const viewsByDateForLocation = useUniqueViewsByDate('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by date
let subscription = viewsElement.getUniqueViewsByDate().subscribe((viewsByDate) => {
console.log('Unique views by date: ', viewsByDate);
});
// you can optionally pass client-location-id to get unique views by date for that location
let subscription = viewsElement.getUniqueViewsByDate('your-location-id').subscribe((viewsByDate) => {
console.log('Unique views by date for location: ', viewsByDate);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
Props:
<velt-view-analytics></velt-view-analytics>
<!-- or -->
<velt-view-analytics
type="location"
location-id="your-location-id">
</velt-view-analytics>
Using Hooks:
const viewsByDate = useUniqueViewsByDate();
const viewsByDateForLocation = useUniqueViewsByDate('your-location-id');
API Methods:
const viewsElement = client.getViewsElement();
// to get unique views by date
let subscription = viewsElement.getUniqueViewsByDate().subscribe((viewsByDate) => {
console.log('Unique views by date: ', viewsByDate);
});
// you can optionally pass client-location-id to get unique views by date for that location
let subscription = viewsElement.getUniqueViewsByDate('your-location-id').subscribe((viewsByDate) => {
console.log('Unique views by date for location: ', viewsByDate);
});
To unsubscribe from the subscription:
subscription?.unsubscribe()
On this page