Skip to main content

Mixpanel Integration

Mixpanel is a product analytics tool that can help you monitor user activity on your HTML Paligo outputs. It provides data about visits to your documentation site and can be useful for identifying trends, such as high numbers of customers looking for help on certain subjects.

Paligo logo with an arrow coming out of it pointing at the mixpanel logo.

Preparations for Mixpanel Integration

To use Mixpanel with Paligo, you need:

  • A Mixpanel account

  • A Mixpanel project token. This is a key that you can find in the Implementation Options section when you first set up a Mixpanel project.

    Implementation Options section in Mixpanel. It contains a project token that you can copy. You need to use the project token in Paligo.

  • A Paligo HTML5 layout, such as the HTML5 help center, see Create a Layout.

  • To host your Paligo HTML5 on a web server so that it is available on the internet and can be monitored by Mixpanel.

When you have these, you can Connect Paligo to Mixpanel.

Connect Paligo to Mixpanel

The Mixpanel integration is only available on HTML5 layouts.

To set up the Paligo-Mixpanel integration so that you can use Mixpanel to monitor your HTML5 output:

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Analytics and other integrations in the sidebar.

    Analytics_and_other_integrations_Layout_small.jpg

  4. Enable the Use cookie consent popup by setting it to Opt-out.

    Use cookie consent popup field. You can disable cookie popups, enable them for info only, or enable them and give the user the ability to opt out of cookies.

    The Paligo-Mixpanel integration uses cookies.

    Note

    To learn more about the cookie consent banner, see Enable or Disable Cookie Consent Popup.

  5. Enter the Mixpanel project token in the Mixpanel tracking field.

    Mixpanel tracking field. It is a text-entry field so you can enter your Mixpanel project token here.

  6. Enable Mixpanel track hash tag in URL if you want Mixpanel to track when the user scrolls down the page to read subsections.

    Disable it if you only want to track top-level sections.

    Mixpanel track hash tag in URL setting. It has an enable option and a disable option.

  7. Select General in the sidebar.

    Layout_General_HTML5_small.png

  8. Enable the Update URL on Scroll to change the URL of the page when a user scrolls down to a subsection. Mixpanel can then track the change to the URL.

    Note

    This step only applies if you enabled Mixpanel hash tag in URL.

    Update URL on scroll setting. It has an Enable option and a Disable option.

  9. Select Save.

When you use this layout to publish your content, Paligo will include the Mixpanel project token in the output. This will allow Mixpanel to find and monitor your HTML5 documentation site when you host your output on a webserver and make it available online.

Note

If a visitor to your documentation website opts out of tracking cookies, their visit is not included in the unique visitors data in Mixpanel.