Skip to content

📈 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!

added custom event API metadata docs

Blue Mouse47ecae05c1f3
diff --git a/docs/api/events.md b/docs/api/events.md
index ff59f0dfb..04988ec3c 100644
--- a/docs/api/events.md
+++ b/docs/api/events.md
@@ -70,6 +70,7 @@ All of the values are numbers in milliseconds.
| `so` | `string` | `false` | A source of the pageview (e.g. `ref`, `source` or `utm_source` GET parameter) |
| `me` | `string` | `false` | A medium of the pageview (e.g. `utm_medium` GET parameter) |
| `ca` | `string` | `false` | A campaign of the pageview (e.g. `utm_campaign` GET parameter) |
+| `meta` | `object` | `false` | A `key` / `value` pair of custom properties for your event (e.g. if your event is `signup`, you can include `meta` like `{ affiliate: 'Yes', currency: 'GBP' }`). The values of the object must be strings, the maximum number of keys allowed is 20 and the total length of the values combined must be less than 1000 characters. |
### Heartbeat event structure
| Name | Type | Required | Description |