typedoc-plugin-umami-analytics
    Preparing search index...

    Type Alias Config

    Configuration options for the Umami Analytics plugin.

    https://umami.is/docs/tracker-configuration

    type Config = {
        umamiScriptURL: string;
        umamiWebsiteID: string;
        umamiHostURL?: string;
        umamiAutoTrack?: boolean;
        umamiDomains?: string[];
        umamiTag?: string;
        umamiExcludeSearch?: boolean;
        umamiExcludeHash?: boolean;
        umamiDoNotTrack?: boolean;
    }
    Index

    Properties

    umamiScriptURL umamiWebsiteID umamiHostURL? umamiAutoTrack? umamiDomains? umamiTag? umamiExcludeSearch? umamiExcludeHash? umamiDoNotTrack?

    Properties

    umamiScriptURL: string

    The URL of the Umami Analytics tracking script, e.g. "https://example.com/script.js"

    umamiWebsiteID: string

    The website ID for your Umami Analytics instance. This is required to track analytics data.

    umamiHostURL?: string

    The URL of the Umami Analytics host, e.g. "https://example-other.com"

    Only use this if your Umami instance is hosted on a different domain than the script URL. If not specified, the script URL's domain will be used.

    umamiAutoTrack?: boolean

    Whether to automatically track page views and events. Defaults to true.

    umamiDomains?: string[]

    A list of domains to track. If specified, only these domains will be tracked. If not specified, all domains where the script is loaded will be tracked.

    umamiTag?: string

    A tag to associate with the analytics data. This can be used to filter or categorize the data in your Umami Analytics dashboard.

    umamiExcludeSearch?: boolean

    Whether to exclude search parameters from the URL when tracking page views.

    umamiExcludeHash?: boolean

    Whether to exclude hash fragments from the URL when tracking page views.

    umamiDoNotTrack?: boolean

    Whether to respect the Do Not Track setting in the user's browser. If true, no analytics data will be sent if the user has enabled Do Not Track.

    Settings

    Member Visibility

    On This Page

    Properties