Events

Everything in your analytics comes from events the pixel sends while a guide plays. Understanding them helps when a number on the Overview tab does not match what you expected, and it is what you will build against once webhooks land.

Four of these events are named in the app today, in the webhooks section of Settings, API & Webhooks.

The four named events

• guide.started A user began the guide. This is the STARTS number, and it is the denominator for completion rate.

• guide.completed A user reached the end of the guide. Together with guide.started this gives you COMPLETION.

• step.skipped A user skipped a step rather than working through it. Repeated skips are what the Skip threshold on the Behavior tab counts, with a default of 3 skips before the guide is permanently dismissed for that user.

• guide.rated A user submitted a rating on the feedback screen at the end of the guide. Ratings are Love, Happy, Neutral, or Sad, with an optional comment.

An impression is separate from a start. The pixel counts a guide being served to a page as an impression, and only counts a start when the user actually begins it, so IMPRESSIONS is always the larger number.

What else is tracked

Beyond those four, Reveal records progress through the guide as it happens: which steps a user reached, and when a user dismissed the guide instead of continuing. That is the raw material for the two analytics views that matter most.

The Step funnel on the Overview tab is built from step-level progress. It shows "% of users reaching each step", which is only possible because reaching a step is recorded on its own rather than inferred from completion.

Drop-off is the other side of the same data. When a guide's step three shows a large fall from step two, that is people who reached step two and never reached step three, whether they dismissed the guide or simply left the page.

Note. Only the four events above are named by the app, so those are the only names to build against. The step-level and dismissal tracking is real and visible in the funnel, but its event names are not published yet. Do not guess them.

Playback surface does not change the events

A guide records the same events whether it plays as live tooltips over your product through the pixel or inside the interactive player in an iframe. Same recording, same steps, same analytics.

That means an embedded player on a marketing page is another view of the same guide, and its starts, completions, and ratings land in the same numbers on the Overview tab. If you want to tell the two apart, use separate guides rather than expecting the analytics to split them for you.

Getting the data out

Coming soon. Webhook endpoints for guide.started, guide.completed, step.skipped, and guide.rated are on the roadmap, and so is the public API. The Webhooks section of Settings, API & Webhooks is marked COMING SOON today, and the API key card is labelled "Public API coming soon". There are no endpoints to call yet.

Two things exist today.

The API key. One Live key per workspace, with full read and write access, sitting under Settings, API & Webhooks ahead of the endpoints it will be used for. See API keys.

Export all data. Under Settings, Danger zone, the Export all data row downloads all guides, analytics, and feedback as CSV. It is the way to get a full copy of your data into a spreadsheet or your own warehouse right now.

Next steps

• API keys: The live key, rotation, and who can manage it.

• Step funnel: Reading drop-off step by step.

• Feedback: Ratings and comments from users who finished.

• Danger zone: Export all data, and the actions you cannot undo.