Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to add event metadata #381

Merged
merged 9 commits into from
Oct 28, 2020
Merged

Ability to add event metadata #381

merged 9 commits into from
Oct 28, 2020

Conversation

ukutaht
Copy link
Contributor

@ukutaht ukutaht commented Oct 23, 2020

Changes

This PR adds ability to add metadata to custom events. Technically it prepares the database for the ability to also add metadata to pageviews since pageviews and events share the same schema (#320).

Interestingly, in one issue this feature is called 'metadata' and in another, it's called 'custom dimensions'. I've went with 'metadata' for now but I'm curious to hear everyone's thoughts on naming this feature.

Currently the tracker only exposes a way to add metadata to custom events through the following API:

plausible('Signup', {meta: {variant: 'A'}})

In the dashboard, this can be interacted with in two possible ways:

  1. When you click on a goal (e.g. 'Signup') then in the conversions report you'll find a UI to break down the conversions according to your metadata keys. Something like 'Show me all signups broken down according to variant'

Screenshot 2020-10-23 at 11 32 14

  1. In the breakdown you can click on a metadata key-value pair to then filter the whole dashboard. So you can start combining filters like Complete Signup and Signup.variant is A

Tests

  • Automated tests have been added

Changelog

  • Entry has been added to changelog

Documentation

  • Docs have been updated

@ukutaht ukutaht marked this pull request as ready for review October 28, 2020 09:07
@ukutaht ukutaht merged commit 40900c7 into master Oct 28, 2020
@ukutaht ukutaht deleted the event-metadata branch October 28, 2020 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant