@logicwind/react-native-matomo-tracker

@logicwind/react-native-matomo-tracker is a React Native library that provides integration with the Matomo analytics platform for tracking user interactions and events in mobile applications and TV applications. This package supported Android, ios, Android TV, Apple TV, Fire TV.

With @logicwind/react-native-matomo-tracker, developers can seamlessly integrate Matomo analytics into their React Native applications, allowing them to track various user interactions such as screen views, button clicks, form submissions, and custom events. This integration enables developers to gain insights into how users interact with their mobile apps, monitor app performance, and make data-driven decisions to improve the user experience.

Installation

Using npm:

npm install  @logicwind/react-native-matomo-tracker

or using yarn:

yarn add @logicwind/react-native-matomo-tracker

Then follow the instructions for your platform to link @logicwind/react-native-matomo-tracker into your project:

iOS installation

React Native 0.70 and above

Run npx pod-install. Linking is not required in React Native 0.70 and above.

tvOS installation

Run npx pod-install. Linking is not required in React Native 0.70 and above.

Create Custom dimension

Dimension contains a key and a value, and where the key is a custom dimension id created on the Matomo dashboard and the value should be a string, you'll need to ensure that the dimensions array is processed correctly. create custom dimension

Usage

import {
createTracker,
setUserId,
setVisitorId,
trackDispatch,
trackDownload,
trackEvent,
trackImpression,
trackInteraction,
trackScreen,
trackSearch,
disableTracking,
enableTracking,
startSession,
trackMediaEvent,
trackCampaign
} from '@logicwind/react-native-matomo-tracker';

createTracker()

The createTracker function is used to instantiate a tracker object for Matomo analytics within a React Native application .It requires the parameters matomo-url and siteId, with the optional parameter auth_token.

note

for matomo-url madatory to add /matomo.php end of url.

• Generate Auth Token Generate auth token guide here

Example

 createTracker("https://your-matomo-url/matomo.php","siteId")

Example with Auth Token

 createTracker("https://your-matomo-url/matomo.php","siteId","auth_token")

startSession()

The MatomoTracker starts a new session whenever the application starts. If you want to start a new session manually, you can use the startSession() function.

Example

startSession()

trackScreen()

The trackScreen method is used to track screen views within a React Native application. It will take screen name,title with the optional parameter dimension.

Example

trackScreen("HomeScreen","Navigate to home screen")

Example with Action Custom Dimensions

trackScreen("HomeScreen","Navigate to home screen",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackEvent()

The trackEvent method is used to track custom events within a React Native application. It will take category,action,name ,value with the optional parameter dimension.

Example

trackEvent("test category","test action"," test name",2);

Example with Action Custom Dimensions

trackEvent("test category","test action"," test name",2,[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

Custom data tracking with track event

trackEvent("basket",JSON.stringify({
id: 3745092,
item: 'mens grey t-shirt',
description: ['round neck', 'long sleeved'],
size: 'L',
}));

Example with Action Custom Dimensions

trackEvent("basket",JSON.stringify({
id: 3745092,
item: 'mens grey t-shirt',
description: ['round neck', 'long sleeved'],
size: 'L',
}),
'',
0,
[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
]
);

trackOutlink()

The trackOutlink method is used to track clicks on outbound links within a React Native application. It will take only url with the optional parameter dimension.

Example

trackOutlink("https://www.google.com/")

Example with Action Custom Dimensions

trackOutlink("https://www.google.com/",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackSearch()

The trackSearch method is used to track search keyword within a React Native application. It will take only keyword with the optional parameter dimension.

Example

trackImpression("Logicwind")

Example with Action Custom Dimensions

trackImpression("Logicwind",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackImpression()

The trackImpression method is used to track specific content or elements within a React Native application. It will take only contentName with the optional parameter dimension.

Example

trackImpression("Test Track Impression")

Example with Action Custom Dimensions

trackImpression("Test Track Impression",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackInteraction()

The trackInteraction method is used to track users engage with specific elements or perform actions within a React Native application. It will take contentName and contentInteraction with the optional parameter dimension.

Example

trackInteraction("Test Track interaction","test inetraction")

Example with Action Custom Dimensions

trackInteraction("Test Track interaction","test inetraction",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackDownload()

The trackDownload method is used to track the download of files or resources within a React Native application. It will take category,action and download-url with the optional parameter dimension.

Example

trackDownload("Download","PDF Download","https://example.com/download.pdf")

Example with Action Custom Dimensions

trackDownload("Download","PDF Download","https://example.com/download.pdf",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

setUserId()

The setUserId function is used to assign a unique identifier to a user in a React Native application. It will take id parameter.

Example

setUserId("[email protected]")

setVisitorId()

By default matomo generate the unique visitor id but if you want custom vistor id then setVisitorId function allows you to manually set a custom visitor ID for tracking purposes within a React Native application . It will take visitor-id parameter. It must be a 16 character long hex string

Example

setVisitorId("2c534f55fba6cf6e")

trackDispatch()

The MatomoTracker will dispatch events every 30 seconds automatically. If you want to dispatch events manually, you can use the trackDispatch() function.

Example

trackDispatch()

disableTracking()

By default the tracking is enable. If you want to disable traking, you can use the disableTracking() function.

Example

disableTracking()

enableTracking()

The enableTracking function is used for enable traking.

Example

enableTracking()

setLogger()

To enable logging for debugging purposes in the Matomo Android SDK and IOS SDK, you can set a custom logger. This is useful to see detailed logs of the SDK’s operations, which can help during development and troubleshooting.

Example

setLogger()

trackMediaEvent()

trackMediaEvent function use to monitor user interactions with media content, such as audio or video files. It allows you to track various events related to media playback, such as play, pause, stop, seek, and complete, providing insights into user engagement with your media assets.

Parameter	Description
mediaId	(required) A unique id that is always the same while playing a media. As soon as the played media changes.
mediaResource	(required) The URL of the media resource.
mediaType	(required) video or audio depending on the type of the media. You can used MediaType.VIDEO or MediaType.AUDIO
mediaTitle	The name / title of the media.
playerName	The name of the media player, for example html5.
mediaStatus	The time in seconds for how long a user has been playing this media. This number should typically increase when you send a media tracking request. It should be 0 if the media was only visible/impressed but not played. Do not increase this number when a media is paused.
mediaLength	The duration (the length) of the media in seconds. For example if a video is 90 seconds long, the value should be 90.
mediaProgress	The progress / current position within the media. Defines basically at which position within the total length the user is currently playing.
mediaTTP	Defines after how many seconds the user has started playing this media. For example a user might have seen the poster of the video for 30 seconds before a user actually pressed the play button.
mediaWidth	The resolution width of the media in pixels. Only recommended being set for videos.
mediaHeight	The resolution height of the media in pixels. Only recommended being set for videos.
mediaFullScreen	Should be 0 or 1 and defines whether the media is currently viewed in full screen. Only recommended being set for videos.
mediaSE	An optional comma separated list of which positions within a media a user has played. For example if the user has viewed position 5s, 10s, 15s and 35s, then you would need to send 5,10,15,35. We recommend to round to the next 5 seconds and not send a value for each second. Internally, Matomo may round to the next 15 or 30 seconds. For performance optimisation we recommend not sending the same position twice. Meaning if you have sent ma_se=10 there is no need to send later ma_se=10,20 but instead only ma_se=20.
dimensions	Dimension contains a key and a value, and where the key is a custom dimension id created on the Matomo dashboard and the value should be a string, you'll need to ensure that the dimensions array is processed correctly. create custom dimension

Example

trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media play track",playerName:"test 08",mediaType:MediaType.VIDEO,mediaResource:"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",mediaStatus:"100",mediaLength:"100",mediaFullScreen:"1",mediaHeight:"720",mediaWidth:"1080",mediaProgress:"100", dimensions:[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
]});

trackCampaign()

Tracking campaigns usually involves recording information about user interactions that can be tied to specific marketing efforts, such as UTM parameters.It requires the parameters title,campaignUrl with the optional parameter dimension

• Default Campaign Tracking Values

• Campaign (Required): mtm_campaign
  A descriptive name for the campaign, e.g. a blog post title or email campaign name.
  

• Keyword (Recommended): mtm_keyword
  The specific keyword that someone searched for, or category of interest.
  

• Additional Campaign Tracking Values

(Available with Matomo Cloud or Marketing Campaigns Reporting Plugin)

• Source (Recommended): mtm_source
  The actual source of the traffic, e.g. newsletter, twitter, ebay, etc.
  

• Medium (Recommended): mtm_medium
  The type of marketing channel, e.g. email, social, paid, etc.
  

• Content (Optional): mtm_content
  This is a specific link or content that somebody clicked. e.g. banner, big-green-button
  

• ID (Optional): mtm_cid
  A unique identifier for your specific ad. This parameter is often used with the numeric IDs automatically generated by advertising platforms.
  

• Group (Requires Matomo 4 or above): mtm_group
  The audience your campaign is targeting e.g. customers, retargeting, etc
  

• Placement (Requires Matomo 4 or above): mtm_placement
  The placement on an advertising network e.g. newsfeed, sidebar, home-banner, etc.
  

If you already have URLs tagged with Google Analytics parameters these are also supported:

• utm_campaign,
• utm_source,
• utm_medium,
• utm_term,
• utm_content,
• utm_id.

Example

trackCampaign("Home screen","https://example.com/?mtm_campaign=2020_august_promo&mtm_source=google&mtm_medium=email&mtm_keyword=august promo&mtm_content=primary-cta")

Example with Action Custom Dimensions

trackCampaign("Home screen","https://example.com/?mtm_campaign=2020_august_promo&mtm_source=google&mtm_medium=email&mtm_keyword=august promo&mtm_content=primary-cta",[
{ key: "1",value:"visit dimension 1" },
{ key:"2",value:"visit dimension 2" },
{ key:"3",value:"action dimension 3" },
{ key:"4",value:"action dimension 4" },
])

trackCustomDimension()

With Custom Dimensions you can assign any custom data to your visitors or actions (like pages, events, site search, ...) and then visualize the reports of how many visits, conversions, pageviews, etc. there were for each Custom Dimension.

Dimension contains a key and a value, and where the key is a custom dimension id created on the Matomo dashboard and the value should be a string, you'll need to ensure that the dimensions array is processed correctly. create custom dimension

Example

trackCustomDimension({
  dimensions:[
  { key: "1",value:"visit dimension 1" },
  { key:"2",value:"visit dimension 2" },
  { key:"3",value:"action dimension 3" },
  { key:"4",value:"action dimension 4" },
  ]
});

Methods

Method	Required Parameter	Android	ios	Android TV	Apple TV	Fire TV
createTracker	uri: String, siteId: Number, token: String	✅	✅	✅	✅	✅
startSession	-	✅	✅	✅	✅	✅
trackScreen	screenName: String, title: String, dimensions:Dimension	✅	✅	✅	✅	✅
trackEvent	category:String, action:String, name:String, value:Number, dimensions:Dimension	✅	✅	✅	✅	✅
trackOutlink	url:String, dimensions:Dimension	✅	✅	✅	✅	✅
trackSearch	keyword:String, dimensions:Dimension	✅	✅	✅	✅	✅
trackImpression	contentName:String, dimensions:Dimension	✅	✅	✅	✅	✅
trackInteraction	contentName:String, contentInteraction:String, dimensions:Dimension	✅	✅	✅	✅	✅
trackDownload	category:String, action:String, url:String	✅	✅	✅	✅	✅
setUserId	id:String	✅	✅	✅	✅	✅
setVisitorId	visitorId:String	✅	✅	✅	✅	✅
trackDispatch	-	✅	✅	✅	✅	✅
disableTracking	-	✅	✅	✅	✅	✅
enableTracking	-	✅	✅	✅	✅	✅
setLogger	-	✅	✅	✅	✅	✅
trackMediaEvent	siteId: String, mediaId: String, mediaTitle: String, playerName: String, mediaType: String, mediaResource: String, mediaStatus: String,mediaLength?:String, mediaProgress?:String, mediaTTP?: String, mediaWidth?: String, mediaHeight?: String, mediaSE?: String, mediaFullScreen?:String, dimensions:Dimension	✅	✅	✅	✅	✅
trackCampaign	title: String, campaignUrl: String, dimensions:[{key:string,value:string}]	✅	✅	✅	✅	✅
trackCustomDimension	dimensions:Dimension	✅	✅	✅	✅	✅

Dimension Object Property

Dimension : [{ key: string,value:string}]

Troubleshooting

How do I fix the tracking failure “Request was not authenticated but should have

You see a failed tracking request with this error message when you use specific tracking parameters as part of the HTTP tracking API without authenticating the request correctly

When such an error occurred, you need to make sure to set a token_auth of a user with at least write permission. If you have set a token, check the set token to make sure it is still the same and no copy/paste error has happened.

To generate a token_auth follow these steps:

• Log in to Matomo
• Go to the Matomo Admin through the top menu
• Click on Personal -> Security
• At the bottom of the page click on “Create new token”
• Confirm your account password
• Enter the purpose for this token
• Choose if the token should only be valid for secure requests (Matomo 5 and newer)

Click on “Create new token” You will now see the newly created token. Save it somewhere safe as you won’t be able to see it anymore once you leave that screen. For example, save it in a password manager. If you lose it, you will need to generate a new token.

How do I fix the tracking not work after successfully inetgration

if you have install matomo successfully but it will not track the event on matomo dashbaord then you have to check your project's bundle name in Matomo's bot detector list to validate if the starting characters match in their list or not. if it is match with your bundle name then you need to chnage your bundle name in ios.

Here's the bot list of Matomo's bot detector: click here

react-native-matomo-tracker is crafted mindfully at Logicwind

We are a 130+ people company developing and designing multiplatform applications using the Lean & Agile methodology. To get more information on the solutions that would suit your needs, feel free to get in touch by email or through or contact form!

We will always answer you with pleasure 😁

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Made with create-react-native-library