umami-api-js
    Preparing search index...

    Interface Filters

    Many endpoints can make use of the filters in this interface

    As defined in the server documentation for the Endpoints in: Events, Sessions, Website stats, Reports

    interface Filters {
        browser?: string;
        city?: string;
        cohort?: string;
        country?: string;
        device?: string;
        hostname?: string;
        os?: string;
        path?: string;
        query?: string;
        referrer?: string;
        region?: string;
        segment?: string;
        tag?: string;
        title?: string;
    }
    Index

    Properties

    browser? city? cohort? country? device? hostname? os? path? query? referrer? region? segment? tag? title?

    Properties

    browser?: string

    Name of browser

    city?: string

    Name of city

    cohort?: string

    UUID of cohort

    country?: string

    Name of country

    device?: string

    Name of device (ex. Mobile)

    hostname?: string

    Name of hostname

    os?: string

    Name of operating system

    path?: string

    Name of URL

    query?: string

    Name of query parameter

    referrer?: string

    Name of referrer

    region?: string

    Name of region/state/province

    segment?: string

    UUID of segment

    tag?: string

    Name of tag

    title?: string

    Name of page title

    Settings

    Member Visibility

    On This Page

    Properties