Skip to content

Update Nuxt package docs #26

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

Merged
adriaandotcom merged 1 commit into from
Nov 7, 2025
Merged

Update Nuxt package docs #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 19 additions & 22 deletions _docs/31_integrations/00_nuxt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,7 @@ You can track pageviews and events from the server during SSR or within Nitro AP
<script setup lang="ts">
if (import.meta.server) {
await trackPageview({
metadata: {
source: "some extra context",
},
some_extra_metadata: "homepage"
});
}
</script>
Expand All @@ -86,32 +84,24 @@ if (import.meta.server) {
```ts
// server/api/signup.post.ts
export default defineEventHandler(async (event) => {
await trackEvent("user_signup", {
event,
metadata: {
source: "registration_form",
user_type: "new",
},
await trackEvent(event, "user_signup", {
source: "registration_form",
user_type: "new",
});

// ...
});
```

## API Reference
## API Reference (Nuxt)

### `trackPageview(options)`

Tracks a pageview on the server.

#### Parameters

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

### `trackEvent(eventName, options)`

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

- `eventName` (string): Name of the event to track
- `options` (object):
- `headers` (Headers): Request headers
- `hostname` (string): Your Simple Analytics hostname
- `metadata` (object): Additional metadata to track
- `ignoreMetrics` (object): Metrics to ignore for this event
- `collectDnt` (boolean): Whether to collect data when DNT is enabled
- `metadata` (object): Additional metadata to track (optional)

## API Reference (Nitro)

### `trackEvent(event, eventName, options)`

Tracks a custom event in a Nitro API route.

#### Parameters

- `event` (H3Event): Nitro request event
- `eventName` (string): Name of the event to track
- `metadata` (object): Additional metadata to track (optional)