APIv2 - initial PR - Githubissues

plausible / analytics

Simple, open source, lightweight (< 1 KB) and privacy-friendly web analytics alternative to Google Analytics.

https://plausible.io

GNU Affero General Public License v3.0

19k stars 1.02k forks source link

APIv2 - initial PR #4216

Closed macobo closed 1 week ago

macobo commented 3 weeks ago

Changes

This PR:

Introduces /api/v2/query - single endpoint to query stats
Introduces new query parsing and result serialization methods
Ports a bunch of breakdown tests over
Updates aggregates.ex to calculate results via new code
Updating imports querying logic to handle single-breakdown cases

Note this is a snapshot of progress. There's a bunch of things this doesn't handle

breakdowns by event:page and event:goal
revenue metrics
timeseries
time range parsing and testing
event:hostname special business logic
conversion_rate special business logic
missing validations
time_on_page metric ... and probably more

These will be solved in follow-up PRs

Tests

[ ] Automated tests have been added
[ ] This PR does not require tests

Changelog

[ ] Entry has been added to changelog
[ ] This PR does not make a user-facing change

Documentation

[ ] Docs have been updated
[ ] This change does not need a documentation update

Dark mode

[ ] The UI has been tested both in dark and light mode
[ ] This PR does not change the UI