Meta tags:
description= The setCustomDimension() method assigns a custom dimension by ID (the supported API). Set the value before the screen view or other tracking call that should carry it. Syntax PiwikTracker.sharedInstance()?.setCustomDimension( identifier: identifier, value: value ) [[PiwikTracker sharedInstance] se…;
Headings (most frequently used words):
sdk, js, api, other, setcustomdimension, browser, consent, manager, android, flutter, ios, react, native, integrations, data, activation, syntax, parameters, examples, notes, related, methods,
Text of the page (most frequently used words):
track (19), value (17), the (15), custom (13), sdk (11), #setcustomdimension (10), piwiktracker (10), sharedinstance (10), tracking (9), dimension (9), methods (8), api (7), and (7), piwik (6), pro (6), nil (6), identifier (6), with (5), cross (5), getting (5), started (5), setcustomvariable (4), data (4), web (4), platform (4), using (4), setuserid (4), dispatch (4), advanced (4), usage (4), examples (3), this (3), you (3), dimensions (3), them (3), that (3), before (3), event (3), setcustomdimensionforid (3), paid (3), subscriber (3), name (3), objective (3), swift (3), set (3), stars (3), sendview (3), view (3), screen (3), other (3), content (3), log (3), for (3), react (3), trackgoal (3), trackecommerceorder (3), trackecommercecartupdate (3), startnewsession (3), setvisitoridlifetime (3), setvisitoridfromdeeplink (3), setvisitorid (3), setsessiontimeout (3), setsessionhash (3), setdispatchinterval (3), setanonymizationstate (3), getuseragent (3), getsessionhash (3), checkaudiencemembership (3), ecommerceremovefromcart (3), ecommerceproductdetailview (3), ecommerceorder (3), ecommercecartupdate (3), ecommerceaddtocart (3), docs (3), related (2), notes (2), parameters (2), syntax (2), page (2), sessiontimeout (2), deprecated (2), includedefaultcustomvariable (2), method (2), index (2), call (2), analytics (2), subscription (2), action (2), renewed (2), path (2), sendevent (2), send (2), welcome (2), required (2), integration (2), pages (2), native (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), setuseremail (2), setprefixing (2), setoptout (2), isanonymizationon (2), getvisitorid (2), getuserid (2), applicationupdate (2), applicationinstall (2), sendapplicationdownload (2), optout (2), dryrun (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, older, favor, scope, after, adding, request, needs, every, apply, clears, setting, sending, need, create, session, menu, settings, then, use, sendeventwithcategory, category, longer, than, characters, truncates, 1024, string, from, admin, rejected, must, greater, integer, assigns, supported, should, carry, mcp, server, skip, link, disable, delay, attribute, layer, security, policy, csp, popup, import, profile, building, identity, resolution, attributes, activation, progressive, applications, pwa, accelerated, mobile, amp, integrations, trackprofileattributes, trackinteraction, trackimpression, trackecommerce, setincludedefaultcustomvariables, setdryrun, isprefixingon, getuseremail, getsessiontimeout, getprofileattributes, getoptout, getincludedefaultcustomvariables, getdryrun, getdispatchinterval, sourcetrafficversion, sourcetrafficname, sessionhash, isprefixingenabled, visitoridlifetime, eventsperrequest, samplerate, appversion, appname, useragent, setvisitoridfrom, deletequeuedevents, visitorid, userid, useremail, sendviews, sendtransaction, sendsocialinteraction, sendsearch, sendaudiencemanagerattribute, sendoutlink, sendgoal, sendexception, senddownload, sendcontentinteraction, sendcontentimpression, sendcampaign, maxnumberofqueuedevents, maxageofqueuedevents, isanonymizationenabled, dispatchinterval, deviceid, checkmembership, ios, trackprofileattribute, trackecommercetransaction, trackcustomvariable, trackcustomdimension, trackappinstall, setincludedefaultvariables, readuserprofileattributes, getvisitoridlifetime, visitvariables, variable, socialinteraction, search, screens, interaction, order, impression, goal, exception, campaign, setusermail, settrafficsourceversion, settrafficsourcename, setofflinecachesize, setofflinecacheage, setincludedefaultcustomvars, setdryruntarget, setdispatchtimeout, setdispatchmode, setdeviceid, setapplicationdomain, items, getdeviceid, audiencemanagersetprofileattribute, android, tracksavechoicesclick, trackreminderwidgetview, trackrejectallclick, trackprivacypolicylinkview, trackmainformview, trackclosebuttonclick, trackagreetoallclick, setinitialcompliancesettings, setcompliancesettings, senddatarequest, openconsentform, getnewcompliancetypes, getcompliancetypes, getcompliancesettings, form, overview, manager, setuserisanonymous, setsessionidstrictprivacymode, setiptracking, getvisitorinfo, resetuserid, deanonymizeuser, user, 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, variables, setcustomdimensionvalue, getcustomdimensionvalue, deletecustomdimension, getcustomdimension, 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, events, plain, javascript, vue, nuxt, next, gatsby, angular, frameworks, browser, jump, agents, visit, https, developers, llms, txt, all, formatted, markdown, endpoints, openapi,
Text of the page (random words):
setcustomdimension 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 setcustomdimension 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 setcustomdimension the setcustomdimension method assigns a custom dimension by id the supported api set the value before the screen view or other tracking call that should carry it syntax swift objective c piwiktracker sharedinstance setcustomdimension identifier identifier value value piwiktracker sharedinstance setcustomdimensionforid identifier value value parameters identifier integer required custom dimension id from the piwik pro admin must be 1 or greater 0 is rejected by the sdk value string required dimension value if longer than 1024 characters the sdk truncates it examples to set a custom dimension with the id 1 and the value 5 stars and send it with a screen view swift objective c piwiktracker sharedinstance setcustomdimension identifier 1 value 5 stars piwiktracker sharedinstance sendview view welcome piwiktracker sharedinstance setcustomdimensionforid 1 value 5 stars piwiktracker sharedinstance sendview welcome to set a custom dimension with the id 2 and the value paid subscriber and send it with an event swift objective c piwiktracker sharedinstance setcustomdimension identifier 2 value paid subscriber piwiktracker sharedinstance sendevent category subscription action renewed name nil value nil path nil piwiktracker sharedinstance setcustomdimensionforid 2 value paid subscriber piwiktracker sharedinstance sendeventwithcategory subscription action renewed name nil value nil path nil notes before setting and sending a custom dimension value you need to create a session or event custom dimension in piwik pro menu analytics settings custom dimensions you then use that dimension s id in this api after adding dimensions to a request the sdk clears them re apply them before every tracking call that needs them the older setcustomdimension index value scope api is deprecated in favor of this method related methods includedefaultcustomvariable setcustomvariable deprecated updated 2 months ago sessiontimeout setcustomvariable did this page help you yes no copy page syntax parameters examples notes related methods
|
