Skip to content

Commit d40fda0

Browse files
JeanMeijeradriaandotcom
authored andcommitted
Update Nuxt package docs
1 parent b0d9e66 commit d40fda0

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

_docs/31_integrations/00_nuxt.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,7 @@ You can track pageviews and events from the server during SSR or within Nitro AP
7373
<script setup lang="ts">
7474
if (import.meta.server) {
7575
await trackPageview({
76-
metadata: {
77-
source: "some extra context",
78-
},
76+
some_extra_metadata: "homepage"
7977
});
8078
}
8179
</script>
@@ -86,32 +84,24 @@ if (import.meta.server) {
8684
```ts
8785
// server/api/signup.post.ts
8886
export default defineEventHandler(async (event) => {
89-
await trackEvent("user_signup", {
90-
event,
91-
metadata: {
92-
source: "registration_form",
93-
user_type: "new",
94-
},
87+
await trackEvent(event, "user_signup", {
88+
source: "registration_form",
89+
user_type: "new",
9590
});
9691

9792
// ...
9893
});
9994
```
10095

101-
## API Reference
96+
## API Reference (Nuxt)
10297

10398
### `trackPageview(options)`
10499

105100
Tracks a pageview on the server.
106101

107102
#### Parameters
108103

109-
- `options` (object):
110-
- `hostname` (string): Your Simple Analytics hostname
111-
- `metadata` (object): Additional metadata to track
112-
- `ignoreMetrics` (object): Metrics to ignore for this pageview
113-
- `collectDnt` (boolean): Whether to collect data when DNT is enabled
114-
- `strictUtm` (boolean): Whether to use strict UTM parameter parsing
104+
- `metadata` (object): Additional metadata to track (optional)
115105

116106
### `trackEvent(eventName, options)`
117107

@@ -120,9 +110,16 @@ Tracks a custom event on the server.
120110
#### Parameters
121111

122112
- `eventName` (string): Name of the event to track
123-
- `options` (object):
124-
- `headers` (Headers): Request headers
125-
- `hostname` (string): Your Simple Analytics hostname
126-
- `metadata` (object): Additional metadata to track
127-
- `ignoreMetrics` (object): Metrics to ignore for this event
128-
- `collectDnt` (boolean): Whether to collect data when DNT is enabled
113+
- `metadata` (object): Additional metadata to track (optional)
114+
115+
## API Reference (Nitro)
116+
117+
### `trackEvent(event, eventName, options)`
118+
119+
Tracks a custom event in a Nitro API route.
120+
121+
#### Parameters
122+
123+
- `event` (H3Event): Nitro request event
124+
- `eventName` (string): Name of the event to track
125+
- `metadata` (object): Additional metadata to track (optional)

0 commit comments

Comments
 (0)