Meta tags:
description=How to identify and track logged-in users with Rybbit;
author=Rybbit Team;
keywords=web analytics,privacy analytics,open source analytics,Google Analytics alternative,website tracking,self-hosted analytics;

Headings (most frequently used words):

window, rybbit, identify, traits, users, how, it, works, special, trait, fields, limits, api, reference, important, notes, complete, example, userid, settraits, clearuserid, getuserid, on, this, page,

Text of the page (most frequently used words):
user (55), #rybbit (33), the (31), window (21), #identify (21), traits (19), and (17), users (15), events (12), with (11), when (10), name (10), this (9), you (9), track (8), identified (8), plan (8), for (8), trait (7), log (7), identification (7), their (7), email (7), from (7), are (7), device (7), clearuserid (6), settraits (6), userid (6), fields (6), event (6), new (6), userdata (6), username (6), data (5), without (5), anonymous (5), same (5), devices (5), tracking (5), will (5), null (5), stored (5), custom (5), getuserid (4), api (4), how (4), documentation (4), console (4), function (4), logs (4), identifying (4), login (4), alias (4), object (4), metadata (4), display (4), across (4), logged (4), your (4), settings (4), guides (4), example (3), reference (3), analytics (3), out (3), newplan (3), set (3), removes (3), not (3), attributed (3), backfill (3), updates (3), currentuserid (3), call (3), setting (3), they (3), any (3), dashboard (3), sessions (3), have (3), self (3), complete (2), important (2), notes (2), limits (2), special (2), works (2), tagging (2), autocapture (2), behavior (2), else (2), const (2), check (2), clear (2), logout (2), upgrade (2), upgraded_at (2), update (2), calling (2), localstorage (2), future (2), delete (2), first (2), created (2), time (2), size (2), subsequent (2), different (2), each (2), field (2), multiple (2), past (2), that (2), currently (2), useful (2), before (2), using (2), note (2), after (2), containing (2), profile (2), all (2), pageviews (2), john (2), fallback (2), primary (2), user_12345 (2), optional (2), like (2), can (2), used (2), provided (2), maximum (2), include (2), pre (2), associate (2), activity (2), visitor (2), processing (2), consent (2), privacy (2), hosting (2), troubleshooting (2), feature (2), traffic (2), 688 (2), github (2), page, use, tags, label, segment, automatically, interactions, writing, code, sending, tab, related, checkuserstatus, status, handlelogout, new_plan, upgraded, toisostring, date, handleplanupgrade, upgrades, method, fullname, handlelogin, here, typical, workflow, does, database, modify, previously, runs, asynchronously, clickhouse, mutations, may, take, short, propagate, depending, table, calls, even, old, retroactive, creates, separate, aliases, linked, independently, via, identified_user_id, cross, address, agent, point, most, recently, were, already, backfilled, retain, original, attribution, shared, current, returns, none, clears, must, warning, removed, temporary_flag, remove, 2024, enterprise, merged, existing, them, updating, properties, initial, associated, acme, inc, company, premium, com, doe, johndoe, recommended, string, unique, identifier, persist, browser, ids, exactly, hashing, modification, sets, 255, characters, length, 2kb, per, json, keep, payloads, concise, also, need, segmentation, analysis, displayed, below, shown, list, session, cards, instead, description, certain, treated, specially, called, given, retroactively, means, once, themselves, view, real, names, store, default, assigns, based, fingerprint, link, known, allowing, allows, persistent, identity, enables, powerful, level, including, journeys, understanding, retention, personalizing, experiences, involves, personal, these, features, ensure, lawful, basis, typically, disclosed, policy, provide, ability, access, only, collect, explicit, process, gdpr, compliance, open, copy, markdown, definitions, other, import, site, inviting, billing, teams, organization, account, migration, managing, installation, quick, start, embeds, funnels, goals, bot, detection, filter, hiding, own, sdks, proxy, guide, integration, script, usage, hosted, cloud, architecture, comparison, introduction, setup, search,

Text of the page (random words):
identify users rybbit search k github rybbit io rybbit 12 4k 688 documentation api reference documentation guides setup and feature documentation github rybbit io rybbit 12 4k 688 introduction comparison architecture self hosted vs cloud usage tracking script troubleshooting track events autocapture identify users tagging integration guides proxy guide sdks hiding your own traffic filter traffic bot detection goals funnels embeds feature guides self hosting quick start managing your installation troubleshooting self hosting guides migration to v1 0 settings account settings organization settings teams billing inviting users site settings data import other definitions identify users identify users how to identify and track logged in users with rybbit copy markdown open gdpr privacy compliance user identification involves processing personal data before using these features ensure you have a lawful basis for processing typically user consent have disclosed tracking in your privacy policy and provide users the ability to access and delete their data only collect traits you have explicit consent to process rybbit allows you to identify logged in users and associate their activity with a persistent identity across devices and sessions this enables powerful user level analytics including tracking user journeys understanding retention and personalizing experiences how it works by default rybbit assigns an anonymous id to each visitor based on their device fingerprint when you call identify you link this anonymous visitor to a known user id allowing you to track the same user across multiple devices associate pre login activity with the logged in user store user metadata traits like email name and custom fields view identified users in your dashboard with their real names when a new alias is created i e the first time identify is called for a given device rybbit retroactively updates all past anonymous events from that device to include the identified user id this means pre login pageviews and events are attributed to the user once they identify themselves special trait fields when identifying users certain trait fields are treated specially by rybbit field description username primary display name shown in the users list and session cards instead of the user id name fallback display name used if username is not provided email displayed below the user s name in the dashboard you can also include any custom fields you need for segmentation and analysis limits traits size maximum 2kb per identify call traits are stored as json so keep payloads concise user id length maximum 255 characters api reference window rybbit identify userid traits sets a custom user id for tracking logged in users across devices and sessions with optional user traits metadata userid string the unique identifier for the user this will be stored in localstorage and persist across browser sessions note custom user ids are stored exactly as provided without any hashing or modification traits object optional an object containing user metadata like email name username or any custom fields this data is stored in rybbit and can be used to identify users in the dashboard setting a trait to null removes it from the user s profile identify a user when they log in without traits window rybbit identify user_12345 identify a user with traits recommended window rybbit identify user_12345 username johndoe primary display name name john doe fallback display name email john example com plan premium company acme inc all subsequent events and pageviews will be associated with this user id window rybbit settraits traits updates the traits for the currently identified user without re identifying them useful for updating user properties after initial identification traits object an object containing user metadata new traits are merged with existing traits setting a trait to null removes it from the user s profile update user traits after they upgrade their plan window rybbit settraits plan enterprise upgraded_at 2024 01 15 remove a trait by setting it to null window rybbit settraits temporary_flag null this trait will be removed note you must call identify before using settraits if no user is identified this will log a warning window rybbit clearuserid clears the stored user id useful when a user logs out clear user identification when user logs out window rybbit clearuserid window rybbit getuserid returns the currently set user id or null if none is set check if a user is identified const currentuserid window rybbit getuserid if currentuserid console log current user currentuserid else console log no user identified important notes shared devices if multiple users log in from the same device same ip address and user agent calling identify with a new user id updates the alias to point to the new user future events will be attributed to the most recently identified user past events that were already backfilled retain their original attribution cross device tracking identifying the same user on different devices creates separate aliases events from each device are linked to the user independently via the identified_user_id field retroactive backfill the backfill runs asynchronously when a new alias is first created clickhouse mutations may take a short time to propagate depending on table size subsequent identify calls from the same device even with a different user id do not re backfill old events clearuserid behavior calling clearuserid removes the user id from localstorage so future events are anonymous it does not delete the alias in the database or modify previously attributed events complete example here s a typical workflow for user identification when user logs in function handlelogin userdata set user identification with traits window rybbit identify userdata id username userdata username name userdata fullname email userdata email plan userdata plan track login event window rybbit event user login method email when user upgrades their plan function handleplanupgrade newplan update traits without re identifying window rybbit settraits plan newplan upgraded_at new date toisostring track upgrade event window rybbit event plan upgraded new_plan newplan when user logs out function handlelogout track logout event window rybbit event user logout clear user identification window rybbit clearuserid check identification status function checkuserstatus const userid window rybbit getuserid if userid console log user is identified userid else console log anonymous user related documentation track events behavior analytics users tab api sending events autocapture automatically track user interactions without writing code tagging how to use tags to label and segment analytics data in rybbit on this page how it works special trait fields limits api reference window rybbit identify userid traits window rybbit settraits traits window rybbit clearuserid window rybbit getuserid important notes complete example