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.

Sign up for GitHub

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

Jump to bottom

Document default Plausible props for frontend analytics events #2767

Open
zackkrida opened this issue Aug 1, 2023 · 0 comments
Open

Document default Plausible props for frontend analytics events #2767

zackkrida opened this issue Aug 1, 2023 · 0 comments
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend

Comments

@zackkrida
Copy link
Member

Problem

When we originally wrote our frontend analytics code we erroneously included many properties in our event payloads which were duplicates of existing, default properties already being collected. This duplication is quite wasteful and can lead to confusion when reviewing analytics events and generating reports.

Description

Add documentation inline in our code, and in any analytics-related docs, which links to the list of default properties collected by Plausible:

https://plausible.io/docs/stats-api#properties
@zackkrida zackkrida added 🟩 priority: low Low priority and doesn't need to be rushed 📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: frontend Related to the Nuxt frontend 🧱 stack: documentation Related to Sphinx documentation labels Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
1 participant
@zackkrida