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
getUserAgent
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
getUserAgent
Copy Page
Syntax
Returns
Examples
Related methods
