📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
custom event metadata
Blue Moused505e8cb8948
diff --git a/docs/api/stats.md b/docs/api/stats.mdindex f5c42db12..0c0097b2e 100644--- a/docs/api/stats.md+++ b/docs/api/stats.md@@ -146,6 +146,11 @@ The timezone to use for the time range. The default is `Etc/GMT`. You can use anAn array of [filter objects](#filters).<hr />+**mode**++[Mode](#mode) used to aggregate the data. The default is `periodic`.+<hr />+### GET /v1/log/performanceThis endpoint accepts the same parameters as the [`/log` endpoint](#get-v1log).@@ -318,6 +323,41 @@ An array of project IDs to return heartbeat events for.A single project ID to return heartbeat events for. You can use either `pids` or `pid` parameter, but not both.<hr />+### GET /v1/log/meta+This endpoint returns an array of custom event metadata.++```bash+curl 'https://api.swetrix.com/v1/log?pid=YOUR_PROJECT_ID&timeBucket=day&period=7d&event=signup'\+ -H "X-Api-Key: ${SWETRIX_API_KEY}"+```++```json title="Response"+[+ {+ "key": "Affiliate",+ "value": "Yes",+ "count": 1+ },+ {+ "key": "Affiliate",+ "value": "No",+ "count": 4+ },+ {+ "key": "OtherMetadata",+ "value": "AnyString",+ "count": 12+ },+]+```++#### Parameters+The parameters are the same as for the [`/log` endpoint](#get-v1log), except additionally you must pass the following the following:++**event**++The name of the custom event to return metadata for.+## Common request examples### Data on visitors from the UK who did not visit the website using a mobile device