Skip to content

Commit

Permalink
Docs: πŸ“ Add page for pro analytics (#2768)
Browse files Browse the repository at this point in the history
* Docs: πŸ“ Add page for pro analytics

* Docs: πŸ› Fix image path
  • Loading branch information
chuckcarpenter committed May 2, 2024
1 parent d679303 commit 7e1773e
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs-src/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ export default defineConfig({
{
label: 'Setup Guide',
link: '/guides/setup/'
},
{
label: 'Analytics',
link: '/guides/analytics/'
}
]
},
Expand Down
Binary file added docs-src/src/assets/pro-integrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs-src/src/content/docs/guides/analytics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Analytics
---

import { Image } from 'astro:assets';
import integrations from '../../../assets/pro-integrations.png';

With Shepherd, you can track the progress of your users through your journey. This can be useful for understanding how users are interacting with your site, and where they might be getting stuck.

## Tracking
Events occur at each step of the journey, and can be tracked using the `on` event handler. Automatically, Shepherd Pro will track the following events: `active`, `cancel`, `complete`, `show`.

### Active
This event triggers when the tour itself becomes active. This means that the tour is ready and not necessarily that the first step is shown.

### Cancel
At any point, if the user cancels the tour, this event will trigger.

### Complete
When the user completes the tour, this event will trigger. This means that the user has gone through all the steps in the tour.

### Show
This event triggers when a step is shown to the user.


## Viewing Analytics
This will then be shown within the Pro portal under the Journey tab. Here you can see the number of times each Journey has been shown, and the number of times it has either been completed or cancelled.

## Integrations
Shepherd Pro integrates with Amplitude and Posthog (with more to come). This allows you to track your Shepherd events alongside your other analytics data to get a more complete picture of interactions with your users.

<Image src={integrations} alt="The Shepherd Pro integrations create form" />

### Amplitude
To enable this, you will need to add your Amplitude API key and secret key to the Shepherd Pro integrations in your dashboard.

### Posthog
To setup Posthog, you will need to add your Posthog API key to the Shepherd Pro integrations in your dashboard.

0 comments on commit 7e1773e

Please sign in to comment.