Skip to content

trackkit / providers/umami/types / UmamiPayload

Type Alias: UmamiPayload

UmamiPayload = object

Defined in: providers/umami/types.ts:37

Core Umami payload structure for both pageviews and events.

Properties

website

website: string

Defined in: providers/umami/types.ts:39

Website ID.


url?

optional url: string

Defined in: providers/umami/types.ts:41

URL being tracked.


name?

optional name: string

Defined in: providers/umami/types.ts:43

Event name (required for type: 'event').


data?

optional data: Record<string, unknown>

Defined in: providers/umami/types.ts:45

Arbitrary event data.


hostname?

optional hostname: string

Defined in: providers/umami/types.ts:47

Hostname.


language?

optional language: string

Defined in: providers/umami/types.ts:49

Browser language.


referrer?

optional referrer: string

Defined in: providers/umami/types.ts:51

Referrer URL.


screen?

optional screen: string

Defined in: providers/umami/types.ts:53

Screen resolution.


title?

optional title: string

Defined in: providers/umami/types.ts:55

Document title.

Released under the MIT License.