Meta tags:
description= User ID The user ID is an optional, non-empty, unique string that identifies the user. It isn’t set by default. It can be a unique username, email address, or another identifier. When the user ID is sent to Analytics with the visitor ID, it helps associate events from different platforms, such as iO…;
Headings (most frequently used words):
sdk, js, api, other, user, id, setting, prefixing, advanced, usage, browser, consent, manager, android, flutter, ios, react, native, integrations, data, activation, email, address, visitor, session, timeout, dispatch, interval, default, custom, variables, opt, out, dry, run,
Text of the page (most frequently used words):
the (92), user (29), you (27), react (25), native (24), using (24), can (23), await (22), piwikprosdk (22), method (21), track (19), #visitor (15), sdk (14), custom (13), email (13), tracking (13), set (12), default (11), dispatch (11), and (11), session (10), this (10), const (10), current (10), events (10), address (9), data (9), app (9), setting (8), advanced (8), usage (8), that (8), when (8), string (8), prefixing (7), opt (7), out (7), variables (7), from (7), piwik (7), pro (7), are (7), with (7), dry (6), run (6), getting (6), started (6), enabled (6), sent (6), all (6), web (6), setuserid (6), methods (6), interval (5), for (5), disable (5), device (5), automatically (5), setdispatchinterval (5), startnewsession (5), setsessiontimeout (5), setvisitoridlifetime (5), setvisitoridfromdeeplink (5), setvisitorid (5), same (5), cross (5), timeout (4), check (4), state (4), whether (4), boolean (4), setprefixing (4), event (4), flag (4), setoptout (4), server (4), index (4), get (4), seconds (4), new (4), getvisitorid (4), setuseremail (4), profile (4), platforms (4), getuserid (4), platform (4), api (4), isprefixingon (3), screen (3), such (3), getdryrun (3), dryrun (3), setdryrun (3), your (3), getoptout (3), optout (3), getincludedefaultcustomvariables (3), setincludedefaultcustomvariables (3), also (3), manually (3), getdispatchinterval (3), getsessiontimeout (3), time (3), analytics (3), long (3), different (3), used (3), getuseremail (3), activation (3), helps (3), ios (3), android (3), identifies (3), unique (3), content (3), log (3), trackgoal (3), trackecommerceorder (3), trackecommercecartupdate (3), setsessionhash (3), setanonymizationstate (3), getuseragent (3), getsessionhash (3), checkaudiencemembership (3), ecommerceremovefromcart (3), ecommerceproductdetailview (3), ecommerceorder (3), ecommercecartupdate (3), ecommerceaddtocart (3), docs (3), page (2), false (2), like (2), social (2), interactions (2), tracker (2), contains (2), exception (2), true (2), test (2), includedefaultcustomvariables (2), each (2), configure (2), version (2), operating (2), system (2), send (2), value (2), dispatched (2), dispatchinterval (2), number (2), locally (2), change (2), 1800 (2), minutes (2), sessiontimeout (2), starts (2), https (2), 0123456789abcdef (2), link (2), visitorid (2), recommend (2), generates (2), panel (2), users (2), attributes (2), more (2), associate (2), works (2), another (2), attribute (2), manager (2), read (2), non (2), empty (2), userid (2), other (2), integration (2), pages (2), tracksocialinteraction (2), tracksearch (2), trackscreen (2), trackoutlink (2), trackexception (2), trackecommerceremovefromcart (2), trackecommerceproductdetailview (2), trackecommerceaddtocart (2), trackdownload (2), trackcustomevent (2), trackcampaign (2), trackapplicationupdate (2), trackapplicationinstall (2), isanonymizationon (2), applicationupdate (2), applicationinstall (2), setcustomvariable (2), setcustomdimension (2), sendapplicationdownload (2), audiencemanagergetprofileattributes (2), additem (2), flutter (2), trackcontentinteraction (2), trackcontentimpression (2), outlink (2), download (2), consent (2), management (2), changelog (2), home (2), copy, did, help, yes, updated, months, ago, currentprefixingstate, prefixingenabled, views, exceptions, path, prefix, caught, fatal, currentdryrunstate, provides, prevents, any, being, enable, debug, implementation, don, want, appear, reports, currentoptoutstate, determines, feature, disabled, tracked, added, separately, see, adds, information, queued, currentdispatchinterval, immediately, negative, aren, need, them, saved, they, every, start, currentsessiontimeout, close, keeps, background, amount, period, defined, opens, again, closes, after, inactivity, counted, last, recorded, days, how, kept, use, example, com, pk_vid, deep, links, website, currentvisitorid, character, hexadecimal, stil, instead, anonymization, doesn, unless, removes, means, assigned, uses, ids, identify, main, which, randomly, first, stores, currentuseremail, represents, protected, collect, create, complete, configured, audience, provided, currentuserid, pass, delete, null, testuserid, always, generated, username, identifier, optional, isn, mcp, skip, delay, layer, name, security, policy, csp, popup, examples, import, building, identity, resolution, progressive, applications, pwa, accelerated, mobile, amp, integrations, trackprofileattributes, trackinteraction, trackimpression, trackecommerce, getprofileattributes, sourcetrafficversion, sourcetrafficname, sessionhash, isprefixingenabled, visitoridlifetime, eventsperrequest, samplerate, appversion, appname, useragent, setvisitoridfrom, deletequeuedevents, useremail, sendviews, sendview, sendtransaction, sendsocialinteraction, sendsearch, sendaudiencemanagerattribute, sendoutlink, sendgoal, sendexception, sendevent, senddownload, sendcontentinteraction, sendcontentimpression, sendcampaign, maxnumberofqueuedevents, maxageofqueuedevents, isanonymizationenabled, includedefaultcustomvariable, deviceid, checkmembership, trackprofileattribute, trackecommercetransaction, trackcustomvariable, trackcustomdimension, trackappinstall, setincludedefaultvariables, readuserprofileattributes, getvisitoridlifetime, visitvariables, variable, socialinteraction, search, screens, interaction, order, impression, goal, dimension, campaign, setusermail, settrafficsourceversion, settrafficsourcename, setofflinecachesize, setofflinecacheage, setincludedefaultcustomvars, setdryruntarget, setdispatchtimeout, setdispatchmode, setdeviceid, setapplicationdomain, items, getdeviceid, audiencemanagersetprofileattribute, tracksavechoicesclick, trackreminderwidgetview, trackrejectallclick, trackprivacypolicylinkview, trackmainformview, trackclosebuttonclick, trackagreetoallclick, setinitialcompliancesettings, setcompliancesettings, senddatarequest, openconsentform, getnewcompliancetypes, getcompliancetypes, getcompliancesettings, form, overview, setuserisanonymous, setsessionidstrictprivacymode, setiptracking, getvisitorinfo, resetuserid, deanonymizeuser, settrackerurl, settimingdatasamplingonpageload, setsiteinspectorsetup, setsiteid, setreferrerurl, setlinktrackingtimer, setdomains, setdocumenttitle, setcustomurl, setenableclienthints, setapiurl, gettrackerurl, gettimingdatasamplingonpageload, getdomains, getsiteid, getpiwikurl, getlinktrackingtimer, discardhashtag, getcurrenturl, addtracker, disableperformancetracking, client, configuration, trackerror, settrackingsourceprovider, settrackingsource, setrequestmethod, setrequestcontenttype, setgenerationtimems, setcustomrequestprocessing, setdonottrack, setcountprerendered, redirectfile, ping, killframe, gettrackingsource, gettrackingsourceprovider, getnumtrackedpageviews, enablejserrortracking, getconfigidpageview, appendtotrackingurl, addlistener, miscellaneous, trackheartbeat, enableheartbeattimer, disableheartbeattimer, heartbeat, setecommerceview, removeecommerceitem, getecommerceitems, clearecommercecart, addecommerceitem, ecommerce, removedownloadclasses, getdownloadextensions, getdownloadclasses, tracklink, adddownloadclasses, setlinkclasses, setignoreclasses, setdownloadextensions, setdownloadclasses, removedownloadextensions, getconfigdownloadextensions, enablelinktracking, disablelinktracking, adddownloadextensions, storecustomvariablesincookie, getcustomvariable, deletecustomvariable, setcustomdimensionvalue, getcustomdimensionvalue, deletecustomdimension, getcustomdimension, dimensions, setcrossdomainlinkingtimeout, iscrossdomainlinkingenabled, getcrossdomainlinkingurlparameter, enablecrossdomainlinking, customcrossdomainlinkvisitoridgetter, disablecrossdomainlinking, customcrossdomainlinkdecorator, domain, linking, setvisitorcookietimeout, setvisitoridcookie, setsessioncookietimeout, setsecurecookie, setcookiepath, setreferralcookietimeout, setcookienameprefix, setcookiedomain, hascookies, getcookiepath, getsessioncookietimeout, getcookiedomain, getconfigvisitorcookietimeout, enablecookies, disablecookies, deletecookies, cookie, trackvisiblecontentimpressions, trackcontentinteractionnode, trackcontentimpressionswithinnode, trackallcontentimpressions, logallcontentblocksonpage, tracksitesearch, trackpageview, trackevent, basic, plain, javascript, vue, nuxt, next, gatsby, angular, frameworks, browser, jump, agents, visit, developers, llms, txt, formatted, markdown, endpoints, openapi,
Text of the page (random words):
advanced usage for ai agents visit https developers piwik pro llms txt for an index of all pages formatted in markdown and endpoints in openapi jump to content home docs web api changelog log in docs log in home docs web api changelog advanced usage browser js api frameworks angular gatsby next js nuxt react vue getting started plain javascript methods basic events trackgoal trackevent trackpageview tracksitesearch content tracking logallcontentblocksonpage trackallcontentimpressions trackcontentimpressionswithinnode trackcontentimpression trackcontentinteractionnode trackcontentinteraction trackvisiblecontentimpressions cookie management deletecookies disablecookies enablecookies getconfigvisitorcookietimeout getcookiedomain getsessioncookietimeout getcookiepath hascookies setcookiedomain setcookienameprefix setreferralcookietimeout setcookiepath setsecurecookie setsessioncookietimeout setvisitoridcookie setvisitorcookietimeout cross domain linking customcrossdomainlinkdecorator disablecrossdomainlinking customcrossdomainlinkvisitoridgetter enablecrossdomainlinking getcrossdomainlinkingurlparameter iscrossdomainlinkingenabled setcrossdomainlinkingtimeout custom dimensions getcustomdimension deletecustomdimension setcustomdimension getcustomdimensionvalue setcustomdimensionvalue custom variables deletecustomvariable getcustomvariable storecustomvariablesincookie setcustomvariable download and outlink adddownloadextensions disablelinktracking enablelinktracking getconfigdownloadextensions removedownloadextensions setdownloadclasses setdownloadextensions setignoreclasses setlinkclasses adddownloadclasses tracklink getdownloadclasses getdownloadextensions removedownloadclasses ecommerce addecommerceitem clearecommercecart ecommerceaddtocart ecommercecartupdate ecommerceorder ecommerceproductdetailview getecommerceitems ecommerceremovefromcart removeecommerceitem setecommerceview trackecommercecartupdate trackecommerceorder heartbeat disableheartbeattimer enableheartbeattimer trackheartbeat miscellaneous addlistener appendtotrackingurl getconfigidpageview enablejserrortracking getnumtrackedpageviews gettrackingsourceprovider gettrackingsource killframe ping redirectfile setcountprerendered setdonottrack setcustomrequestprocessing setgenerationtimems setrequestcontenttype setrequestmethod settrackingsource settrackingsourceprovider trackerror tracking client configuration disableperformancetracking addtracker getcurrenturl discardhashtag getlinktrackingtimer getpiwikurl getsiteid getdomains gettimingdatasamplingonpageload gettrackerurl setapiurl setenableclienthints setcustomurl setdocumenttitle setdomains setlinktrackingtimer setreferrerurl setsiteid setsiteinspectorsetup settimingdatasamplingonpageload settrackerurl user management deanonymizeuser getuserid getvisitorid resetuserid getvisitorinfo setiptracking setsessionidstrictprivacymode setuserid setuserisanonymous consent manager js api overview custom consent form methods getcompliancesettings getcompliancetypes getnewcompliancetypes openconsentform senddatarequest setcompliancesettings setinitialcompliancesettings trackagreetoallclick trackclosebuttonclick trackmainformview trackprivacypolicylinkview trackrejectallclick trackreminderwidgetview tracksavechoicesclick android sdk methods audiencemanagergetprofileattributes audiencemanagersetprofileattribute checkaudiencemembership dispatch ecommerceaddtocart ecommercecartupdate ecommerceorder ecommerceproductdetailview ecommerceremovefromcart getsessionhash getdeviceid getuseragent isanonymizationon items additem setanonymizationstate setapplicationdomain setdispatchinterval setdeviceid setdispatchmode setdispatchtimeout setdryruntarget setincludedefaultcustomvars setofflinecacheage setofflinecachesize setprefixing setoptout setsessiontimeout setsessionhash settrafficsourcename settrafficsourceversion setusermail setuserid setvisitorid setvisitoridfromdeeplink setvisitoridlifetime track applicationinstall startnewsession track applicationupdate track campaign track dimension track download track event track exception track goal track impression track order track interaction track outlink track screen track screens track search track socialinteraction track sendapplicationdownload track variable track visitvariables getting started using piwik pro sdk cross platform tracking advanced usage flutter sdk methods checkaudiencemembership dispatch dryrun getsessionhash getuseragent getvisitoridlifetime readuserprofileattributes optout setanonymizationstate setdispatchinterval setincludedefaultvariables setsessionhash setuseremail setsessiontimeout setuserid setvisitorid setvisitoridfromdeeplink trackappinstall setvisitoridlifetime trackapplicationinstall trackapplicationupdate trackcampaign trackcontentimpression trackcontentinteraction trackcustomdimension trackcustomvariable trackcustomevent trackdownload trackecommerceaddtocart trackecommercecartupdate trackecommerceorder trackecommerceproductdetailview trackecommercetransaction trackecommerceremovefromcart trackexception trackgoal trackprofileattribute trackoutlink trackscreen tracksearch tracksocialinteraction getting started using the flutter sdk advanced usage cross platform tracking ios sdk getting started methods additem audiencemanagergetprofileattributes checkmembership deviceid dispatchinterval dryrun ecommerceaddtocart ecommercecartupdate ecommerceorder ecommerceproductdetailview ecommerceremovefromcart includedefaultcustomvariable isanonymizationenabled maxageofqueuedevents maxnumberofqueuedevents optout sendapplicationdownload sendcampaign sendcontentimpression sendcontentinteraction senddownload sendevent sendexception sendgoal sendoutlink sendaudiencemanagerattribute sendsearch sendsocialinteraction sendtransaction sendview sendviews sessiontimeout setcustomdimension setcustomvariable startnewsession useremail userid visitorid applicationinstall applicationupdate dispatch deletequeuedevents setvisitoridfrom useragent appname appversion samplerate eventsperrequest visitoridlifetime isprefixingenabled sessionhash sourcetrafficname sourcetrafficversion using piwik pro sdk cross platform tracking advanced usage react native sdk advanced usage getting started methods checkaudiencemembership dispatch getdispatchinterval getdryrun getincludedefaultcustomvariables getoptout getprofileattributes getsessionhash getsessiontimeout getuseragent getuseremail getuserid getvisitorid isanonymizationon isprefixingon setanonymizationstate setdispatchinterval setdryrun setincludedefaultcustomvariables setoptout setprefixing setsessionhash setsessiontimeout setuseremail setuserid setvisitorid setvisitoridfromdeeplink setvisitoridlifetime startnewsession trackapplicationinstall trackapplicationupdate trackcampaign trackcustomevent trackdownload trackecommerce trackecommerceaddtocart trackecommercecartupdate trackecommerceorder trackecommerceproductdetailview trackecommerceremovefromcart trackexception trackgoal trackimpression trackoutlink trackinteraction trackprofileattributes trackscreen tracksearch tracksocialinteraction using piwik pro sdk for react native cross platform tracking other integrations accelerated mobile pages amp integration progressive web applications integration pwa web log analytics data activation custom attributes identity resolution profile building data import other custom popup examples content security policy csp custom data layer name skip link tracking with the data disable delay attribute mcp server advanced usage user id the user id is an optional non empty unique string that identifies the user it isn t set by default it can be a unique username email address or another identifier when the user id is sent to analytics with the visitor id it helps associate events from different platforms such as ios and android with the same user this works as long as the same user id is used on all platforms the visitor id is always generated automatically by the sdk read more you can set a user id with the setuserid method react native await piwikprosdk setuserid testuserid userid string a unique non empty string that identifies the user pass null to delete the current user id you can read the current user id using the getuserid method react native const currentuserid await piwikprosdk getuserid user email address the user email address is another string that identifies users when you send the custom profile attribute configured in the audience manager web panel the provided user email address is sent to data activation like the user id the user email address helps associate data from different platforms such as ios and android with the same user this works as long as the same email address is used on all platforms we recommend setting the user email address when you collect data activation profile attributes this helps create a more complete user profile you can set a user email with the setuseremail method react native await piwikprosdk setuseremail email protected email string a string that represents an email address you can get the current user email using the getuseremail method react native const currentuseremail await piwikprosdk getuseremail visitor id the sdk uses different ids to identify users the main id is the visitor id which the sdk randomly generates the first time it s used and stores locally on the device the visitor id doesn t change unless the user removes the app from the device this means events sent from the device are assigned to the same user in the piwik pro web panel when anonymization is enabled the sdk generates a new visitor id each time the app starts we recommend using the user id instead of the visitor id you can stil set a visitor id using the setvisitorid method react native await piwikprosdk setvisitorid 0123456789abcdef visitorid string a 16 character hexadecimal string that contains a new visitor id you can get the current visitor id using the getvisitorid method react native const currentvisitorid await piwikprosdk getvisitorid you can also set the visitor id from a deep link using the setvisitoridfromdeeplink method this links a website visitor to an app visitor react native const ok await piwikprosdk setvisitoridfromdeeplink https example com pk_vid 0123456789abcdef to set how long the visitor id is kept use the setvisitoridlifetime react native await piwikprosdk setvisitoridlifetime 30 24 60 60 30 days in seconds setting session timeout a session is a set of user interactions with your app by default analytics closes the session after 30 minutes of inactivity counted from the last recorded event in the session when the user opens the app again a new session starts you can configure the tracker to automatically close the session when the user keeps your app in the background for a set amount of time that period is defined by the setsessiontimeout method react native await piwikprosdk setsessiontimeout 1800 sessiontimeout number session timeout in seconds default 1800 30 minutes you can get the current session timeout using the getsessiontimeout method react native const currentsessiontimeout await piwikprosdk getsessiontimeout you can also start manually a new session using the startnewsession method react native await piwikprosdk startnewsession setting dispatch interval all tracking events are saved locally and by default they are automatically sent to the server every 30 seconds you can change this interval using the setdispatchinterval method react native await piwikprosdk setdispatchinterval 25 dispatchinterval number the dispatch interval in seconds default value 30 if set to 0 events are dispatched immediately if set to a negative value events aren t dispatched automatically and you need to dispatch them manually you can get the current dispatch interval using the getdispatchinterval method react native const currentdispatchinterval await piwikprosdk getdispatchinterval you can also manually send all queued events to the server using the dispatch method react native await piwikprosdk dispatch default custom variables the sdk by default automatically adds device operating system and app version information as custom variables index 1 device index 2 operating system index 3 app version this setting is enabled by default to configure custom variables separately disable this setting and see tracking custom variables you can disable this setting using the setincludedefaultcustomvariables method react native await piwikprosdk setincludedefaultcustomvariables false includedefaultcustomvariables boolean whether default custom variables are added to each tracking event you can check the current state using the getincludedefaultcustomvariables method react native const includedefaultcustomvariables await piwikprosdk getincludedefaultcustomvariables opt out you can disable all tracking in the app using the opt out feature no events are sent to the server if the opt out is set by default opt out is disabled and events are tracked you can opt out of tracking using the setoptout method react native await piwikprosdk setoptout true optout boolean flag that determines whether opt out is enabled you can check the current state using the getoptout method react native const currentoptoutstate await piwikprosdk getoptout dry run the sdk provides a dry run flag that prevents any data from being sent to piwik pro when enabled enable dry run flag when you test or debug an implementation and don t want test data to appear in your piwik pro reports you can set the dry run flag using the setdryrun method react native await piwikprosdk setdryrun true dryrun boolean whether dry run is enabled you can check the current state using the getdryrun method react native const currentdryrunstate await piwikprosdk getdryrun prefixing prefixing for tracking events like screen views exceptions or social interactions the event path in the tracker contains a prefix such as screen social fatal caught or exception you can disable prefixing using the setprefixing method react native await piwikprosdk setprefixing false prefixingenabled boolean whether prefixing is enabled you can check the current prefixing state using the isprefixingon method react native const currentprefixingstate await piwikprosdk isprefixingon updated 2 months ago advanced usage getting started did this page help you yes no copy page user id user email address visitor id setting session timeout setting dispatch interval default custom variables opt out dry run prefixing prefixing
|
