https://github.com/moisesbaez/mautic-tracking

Tracking tool for Mautic
https://github.com/moisesbaez/mautic-tracking

Last synced: 30 days ago
JSON representation

Tracking tool for Mautic

• Host: GitHub
• URL: https://github.com/moisesbaez/mautic-tracking
• Owner: moisesbaez
• Created: 2019-02-15T01:45:23.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:39:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T14:52:12.722Z (about 1 month ago)
• Language: JavaScript
• Size: 690 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mautic - https://github.com/moisesbaez/mautic-tracking - React Tracking tool for Mautic (Libraries)

README

        
# mautic-tracking

### Tracking tool for Mautic marketing sofware.

This is a JavaScript module for implementing [Mautic](https://www.mautic.org/)  tracking into a website. Can be used client side on React.

## Installation

```bash

npm install --save mautic-tracking

```

## Usage

Initializing Mautic module:

```js

import mautic from 'mautic-tracking';

mautic.initialize('https://my.mautic-installation.com/mtc.js');

```

### Send page views:

```js

mautic.pageView({ custom: 'options' });

```

## API

#### mautic.initialize(mtcPath)

|Value|Type|Required|Notes|

|------|-----|-----|-----|

|mtcPath| `String`| Yes | The path to your `mtc.js` file.|

#### mautic.pageView(options)

|Value|Type|Required|Notes|

|------|-----|-----|-----|

|options| `Object`| No | Object with custom values that you wish to pass to your mautic software on each page view.|

## License

Released under the MIT license

Copyright (c) 2019 Moises Baez