umami-api-js 0.0.3 → 0.1.0

package/dist/namespaces/Admin.js

@@ -1,25 +1,19 @@
-/** For endpoints listed on: https://umami.is/docs/api/admin-api */
+/** Operations around admin management: https://umami.is/docs/api/admin */
 export var Admin;
 (function (Admin) {
-    /** Returns all users: https://umami.is/docs/api/admin-api#get-apiadminusers */
+    /** Returns all users: https://umami.is/docs/api/admin#get-apiadminusers */
     async function getUsers(parameters) {
         const response = await this.request("get", ["admin", "users"], parameters);
         return response.data;
     }
     Admin.getUsers = getUsers;
-    /**
-     * Returns all websites: https://umami.is/docs/api/admin-api#get-apiadminwebsites
-     * @remarks TODO Possibly doesn't work? (throws 400 on my end)
-     */
+    /** Returns all websites: https://umami.is/docs/api/admin#get-apiadminwebsites */
     async function getWebsites(parameters) {
         const response = await this.request("get", ["admin", "websites"], parameters);
         return response.data;
     }
     Admin.getWebsites = getWebsites;
-    /**
-     * Returns all teams: https://umami.is/docs/api/admin-api#get-apiadminteams
-     * @remarks TODO Possibly doesn't work? (throws 404 on my end)
-     */
+    /** Returns all teams: https://umami.is/docs/api/admin#get-apiadminteams */
     async function getTeams(parameters) {
         const response = await this.request("get", ["admin", "teams"], parameters);
         return response.data;

package/dist/namespaces/Events.d.ts

@@ -1,8 +1,8 @@
 import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/events-api */
+/** Operations around Events and Event data: https://umami.is/docs/api/events */
 export declare namespace Events {
-    /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
-    function getWebsiteEvents(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<{
+    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
+    function get_WEBSITEID_Events(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<{
         id: string;
         websiteId: string;
         sessionId: string;
@@ -23,8 +23,8 @@ export declare namespace Events {
         eventName: string;
         hasData: number;
     }[]>;
-    /** Gets event-data for a individual event https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
-    function getWebsiteEventData(this: API, websiteId: string, eventId: string): Promise<{
+    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
+    function get_WEBSITEID_Eventdata_EVENTID(this: API, websiteId: string, eventId: string): Promise<{
         websiteId: string;
         sessionId: string;
         eventId: string;
@@ -37,8 +37,8 @@ export declare namespace Events {
         dataType: number;
         createdAt: Date;
     }[]>;
-    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
-    function getWebsiteEventsData(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
+    function get_WEBSITEID_EventdataEvents(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event?: string;
     }): Promise<{
@@ -47,21 +47,21 @@ export declare namespace Events {
         dataType: number;
         total: number;
     }[]>;
-    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
-    function getWebsiteEventsDataFields(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
+    function get_WEBSITEID_EventdataFields(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         propertyName: string;
         dataType: number;
         value: string;
         total: number;
     }[]>;
-    /** Gets event name and property counts for a website: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
-    function getWebsiteEventsDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
+    function get_WEBSITEID_EventdataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         eventName: string;
         propertyName: string;
         total: number;
     }[]>;
-    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
-    function getWebsiteEventsDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
+    function get_WEBSITEID_EventdataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event: string;
         /** Property name */
@@ -70,8 +70,8 @@ export declare namespace Events {
         value: string;
         total: number;
     }>;
-    /** Gets aggregated website events, properties, and records within a given time range https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
-    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
+    function get_WEBSITEID_EventdataStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         events: number;
         properties: number;
         records: number;

package/dist/namespaces/Events.js

@@ -1,40 +1,40 @@
-/** For endpoints listed on: https://umami.is/docs/api/events-api */
+/** Operations around Events and Event data: https://umami.is/docs/api/events */
 export var Events;
 (function (Events) {
-    /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
-    async function getWebsiteEvents(websiteId, parameters) {
+    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
+    async function get_WEBSITEID_Events(websiteId, parameters) {
         const response = await this.request("get", ["websites", websiteId, "events"], parameters);
         return response.data;
     }
-    Events.getWebsiteEvents = getWebsiteEvents;
-    /** Gets event-data for a individual event https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
-    async function getWebsiteEventData(websiteId, eventId) {
+    Events.get_WEBSITEID_Events = get_WEBSITEID_Events;
+    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
+    async function get_WEBSITEID_Eventdata_EVENTID(websiteId, eventId) {
         return await this.request("get", ["websites", websiteId, "event-data", eventId]);
     }
-    Events.getWebsiteEventData = getWebsiteEventData;
-    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
-    async function getWebsiteEventsData(websiteId, parameters) {
+    Events.get_WEBSITEID_Eventdata_EVENTID = get_WEBSITEID_Eventdata_EVENTID;
+    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
+    async function get_WEBSITEID_EventdataEvents(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "events"], parameters);
     }
-    Events.getWebsiteEventsData = getWebsiteEventsData;
-    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
-    async function getWebsiteEventsDataFields(websiteId, parameters) {
+    Events.get_WEBSITEID_EventdataEvents = get_WEBSITEID_EventdataEvents;
+    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
+    async function get_WEBSITEID_EventdataFields(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "fields"], parameters);
     }
-    Events.getWebsiteEventsDataFields = getWebsiteEventsDataFields;
-    /** Gets event name and property counts for a website: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
-    async function getWebsiteEventsDataProperties(websiteId, parameters) {
+    Events.get_WEBSITEID_EventdataFields = get_WEBSITEID_EventdataFields;
+    /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
+    async function get_WEBSITEID_EventdataProperties(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "properties"], parameters);
     }
-    Events.getWebsiteEventsDataProperties = getWebsiteEventsDataProperties;
-    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
-    async function getWebsiteEventsDataValues(websiteId, parameters) {
+    Events.get_WEBSITEID_EventdataProperties = get_WEBSITEID_EventdataProperties;
+    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
+    async function get_WEBSITEID_EventdataValues(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "values"], parameters);
     }
-    Events.getWebsiteEventsDataValues = getWebsiteEventsDataValues;
-    /** Gets aggregated website events, properties, and records within a given time range https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
-    async function getWebsiteEventsDataStats(websiteId, parameters) {
+    Events.get_WEBSITEID_EventdataValues = get_WEBSITEID_EventdataValues;
+    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
+    async function get_WEBSITEID_EventdataStats(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "stats"], parameters);
     }
-    Events.getWebsiteEventsDataStats = getWebsiteEventsDataStats;
+    Events.get_WEBSITEID_EventdataStats = get_WEBSITEID_EventdataStats;
 })(Events || (Events = {}));

package/dist/namespaces/Links.d.ts

@@ -0,0 +1,28 @@
+import { API, GenericObject, GenericRequestParameters } from "../index.js";
+/** Operations around Links management: https://umami.is/docs/api/links */
+export declare namespace Links {
+    interface Link extends GenericObject {
+        name: string;
+        url: string;
+        slug: string;
+        userId: string;
+        teamid: string | null;
+    }
+    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
+    function get(this: API, parameters?: GenericRequestParameters): Promise<Link[]>;
+    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid (TODO UNTESTED) */
+    function get_LINKID(this: API, linkId: Link["id"]): Promise<Link>;
+    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid (TODO UNTESTED) */
+    function post_LINKID(this: API, linkId: Link["id"], parameters: {
+        /** The link's name */
+        name?: string;
+        /** The link's destination URL */
+        url?: string;
+        /** The link's URL slug, **with a minimum of 8 characters** */
+        slug?: string;
+    }): Promise<Link>;
+    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
+    function delete_LINKID(this: API, linkId: Link["id"]): Promise<{
+        ok: boolean;
+    }>;
+}

package/dist/namespaces/Links.js

@@ -0,0 +1,25 @@
+/** Operations around Links management: https://umami.is/docs/api/links */
+export var Links;
+(function (Links) {
+    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
+    async function get(parameters) {
+        const response = await this.request("get", ["links"], parameters);
+        return response.data;
+    }
+    Links.get = get;
+    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid (TODO UNTESTED) */
+    async function get_LINKID(linkId) {
+        return await this.request("get", ["links", linkId]);
+    }
+    Links.get_LINKID = get_LINKID;
+    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid (TODO UNTESTED) */
+    async function post_LINKID(linkId, parameters) {
+        return await this.request("post", ["links", linkId], parameters);
+    }
+    Links.post_LINKID = post_LINKID;
+    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
+    async function delete_LINKID(linkId) {
+        return await this.request("delete", ["links", linkId]);
+    }
+    Links.delete_LINKID = delete_LINKID;
+})(Links || (Links = {}));

package/dist/namespaces/Me.d.ts

@@ -0,0 +1,44 @@
+import { API, GenericObject, MinimalUser, Role, TeamRole } from "../index.js";
+/** All information about your session: https://umami.is/docs/api/me */
+export declare namespace Me {
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime (TODO UNTESTED) */
+    function get(this: API): Promise<{
+        token: string;
+        authKey: string;
+        shareToken: string | null;
+        user: {
+            id: string;
+            username: string;
+            role: Role;
+            createdAt: Date;
+            isAdmin: boolean;
+        };
+    }>;
+    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    function getTeams(this: API): Promise<(GenericObject & {
+        name: string;
+        accessCode: string;
+        logoUrl: string | null;
+        members: (Omit<GenericObject, "deletedAt"> & {
+            teamId: string;
+            userId: string;
+            role: TeamRole;
+            user: MinimalUser;
+        })[];
+        _count: {
+            websites: number;
+            members: number;
+        };
+    })[]>;
+    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    function getWebsites(this: API): Promise<(GenericObject & {
+        name: string;
+        domain: string;
+        shareId: string | null;
+        resetAt: Date | null;
+        userId: string;
+        teamId: string | null;
+        createdBy: string;
+        user: MinimalUser;
+    })[]>;
+}

package/dist/namespaces/Me.js

@@ -0,0 +1,21 @@
+/** All information about your session: https://umami.is/docs/api/me */
+export var Me;
+(function (Me) {
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime (TODO UNTESTED) */
+    async function get() {
+        return await this.request("get", ["me"]);
+    }
+    Me.get = get;
+    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    async function getTeams() {
+        const response = await this.request("get", ["me", "teams"]);
+        return response.data;
+    }
+    Me.getTeams = getTeams;
+    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    async function getWebsites() {
+        const response = await this.request("get", ["me", "websites"]);
+        return response.data;
+    }
+    Me.getWebsites = getWebsites;
+})(Me || (Me = {}));

package/dist/namespaces/Pixels.d.ts

@@ -0,0 +1,25 @@
+import { API, GenericObject, GenericRequestParameters } from "../index.js";
+/** Operations around Pixels management: https://umami.is/docs/api/pixels */
+export declare namespace Pixels {
+    interface Pixel extends GenericObject {
+        name: string;
+        slug: string;
+        userId: string;
+        teamid: string | null;
+    }
+    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
+    function get(this: API, parameters?: GenericRequestParameters): Promise<Pixel[]>;
+    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid (TODO UNTESTED) */
+    function get_PIXELID(this: API, pixelId: Pixel["id"]): Promise<Pixel>;
+    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid (TODO UNTESTED) */
+    function post_PIXELID(this: API, pixelId: Pixel["id"], parameters: {
+        /** The pixel's name */
+        name?: string;
+        /** The pixel's URL slug, **with a minimum of 8 characters** */
+        slug?: string;
+    }): Promise<Pixel>;
+    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
+    function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<{
+        ok: boolean;
+    }>;
+}

package/dist/namespaces/Pixels.js

@@ -0,0 +1,25 @@
+/** Operations around Pixels management: https://umami.is/docs/api/pixels */
+export var Pixels;
+(function (Pixels) {
+    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
+    async function get(parameters) {
+        const response = await this.request("get", ["pixels"], parameters);
+        return response.data;
+    }
+    Pixels.get = get;
+    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid (TODO UNTESTED) */
+    async function get_PIXELID(pixelId) {
+        return await this.request("get", ["pixels", pixelId]);
+    }
+    Pixels.get_PIXELID = get_PIXELID;
+    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid (TODO UNTESTED) */
+    async function post_PIXELID(pixelId, parameters) {
+        return await this.request("post", ["pixels", pixelId], parameters);
+    }
+    Pixels.post_PIXELID = post_PIXELID;
+    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
+    async function delete_PIXELID(pixelId) {
+        return await this.request("delete", ["pixels", pixelId]);
+    }
+    Pixels.delete_PIXELID = delete_PIXELID;
+})(Pixels || (Pixels = {}));

package/dist/namespaces/Realtime.d.ts

@@ -1,8 +1,8 @@
 import { API } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/realtime-api */
+/** Realtime data for your website: https://umami.is/docs/api/realtime */
 export declare namespace Realtime {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime-api#get-apirealtimewebsiteid (TODO UNTESTED) */
-    function getRealtime(this: API, websiteId: string): Promise<{
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid (TODO UNTESTED) */
+    function get_WEBSITEID(this: API, websiteId: string): Promise<{
         countries: {
             [k: string]: number;
         };

package/dist/namespaces/Realtime.js

@@ -1,9 +1,9 @@
-/** For endpoints listed on: https://umami.is/docs/api/realtime-api */
+/** Realtime data for your website: https://umami.is/docs/api/realtime */
 export var Realtime;
 (function (Realtime) {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime-api#get-apirealtimewebsiteid (TODO UNTESTED) */
-    async function getRealtime(websiteId) {
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid (TODO UNTESTED) */
+    async function get_WEBSITEID(websiteId) {
         return await this.request("post", ["realtime", websiteId]);
     }
-    Realtime.getRealtime = getRealtime;
+    Realtime.get_WEBSITEID = get_WEBSITEID;
 })(Realtime || (Realtime = {}));

package/dist/namespaces/Reports.d.ts

@@ -0,0 +1,146 @@
+import { API, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
+/** Using reports throught the api: https://umami.is/docs/api/reports */
+export declare namespace Reports {
+    type ReportType = {
+        type: "attribution" | "breakdown" | "funnel" | "goal" | "journey" | "retention" | "revenue" | "utm";
+    };
+    interface UTM {
+        utm: string;
+        views: number;
+    }
+    /** Get all reports by website ID: https://umami.is/docs/api/reports#get-apireports (TODO UNTESTED) */
+    function get(this: API, websiteId: string, parameters: ReportType & Omit<GenericRequestParameters, "search">): Promise<Report[]>;
+    /** Creates a report: https://umami.is/docs/api/reports#post-apireports (TODO UNTESTED) */
+    function post(this: API, websiteId: string, parameters: ReportType & {
+        /** Name of report */
+        name: string;
+        /** Description of report */
+        description?: string;
+        /** Parameters for report */
+        parameters?: any;
+    }): Promise<Report>;
+    /** Gets a report by ID: https://umami.is/docs/api/reports#get-apireportsreportid (TODO UNTESTED) */
+    function get_REPORTID(this: API, reportId: string): Promise<Report>;
+    /** Updates a report: https://umami.is/docs/api/reports#post-apireportsreportid (TODO UNTESTED) */
+    function post_REPORTID(this: API, reportId: string, websiteId: string, parameters: ReportType & {
+        /** Name of report */
+        name: string;
+        /** Description of report */
+        description?: string;
+        /** Parameters for report */
+        parameters?: any;
+    }): Promise<Report>;
+    /** Deletes a report: https://umami.is/docs/api/reports#delete-apireportsreportid (TODO UNTESTED) */
+    function delete_REPORTID(this: API, reportId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports#post-apireportsattribution (TODO UNTESTED) */
+    function postAttribution(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Attribution model */
+        model: "firstClick" | "lastClick";
+        /** Conversion type */
+        type: ("path" | "event")[];
+        /** Conversion step */
+        step: string;
+    }): Promise<{
+        referrer: NameValue[];
+        paidAds: NameValue[];
+        utm_source: NameValue[];
+        utm_medium: NameValue[];
+        utm_campaign: NameValue[];
+        utm_content: NameValue[];
+        utm_term: NameValue[];
+        total: {
+            pageviews: number;
+            visitors: number;
+            visits: number;
+        };
+    }>;
+    /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports#post-apireportsbreakdown (TODO UNTESTED) */
+    function postBreakdown(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        fields: ("path" | "title" | "query" | "referrer" | "browser" | "os" | "device" | "country" | "region" | "city" | "hostname" | "tag" | "event")[];
+    }): Promise<{
+        views: number;
+        visitors: number;
+        visits: number;
+        bounces: number;
+        totaltime: number;
+        os: string;
+        country: string;
+    }[]>;
+    /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports#post-apireportsfunnel (TODO UNTESTED) */
+    function postFunnel(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Type of event and conversion step */
+        steps: {
+            type: "path" | "event";
+            value: string;
+        }[];
+        /** Window of days between funnel steps to be considered a conversion */
+        window: number;
+    }): Promise<{
+        type: string;
+        value: string;
+        visitors: number;
+        previous: number;
+        dropped: number;
+        dropoff: number | null;
+        remaining: number;
+    }[]>;
+    /** Track your goals for pageviews and events: https://umami.is/docs/api/reports#post-apireportsgoals (TODO UNTESTED) */
+    function postGoals(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Conversion type */
+        type: ("path" | "event")[];
+        /** Conversion step value */
+        value: string;
+    }): Promise<{
+        num: number;
+        total: number;
+    }>;
+    /** Understand how users nagivate through your website: https://umami.is/docs/api/reports#post-apireportsjourney (TODO UNTESTED) */
+    function postJourney(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Number of steps from 3 to 7 */
+        steps: number;
+        /** Starting step URL or event name */
+        startStep: string;
+        /** Ending step URL or event name */
+        endStep?: string;
+    }): Promise<{
+        items: (string | null)[];
+        count: number;
+    }[]>;
+    /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports#post-apireportsretention (TODO UNTESTED) */
+    function postRetention(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<{
+        date: Date;
+        day: number;
+        visitors: number;
+        returnVisitors: number;
+        percentage: number;
+    }[]>;
+    /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports#post-apireportsrevenue (TODO UNTESTED) */
+    function postRevenue(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Currency code (ISO 4217) */
+        currency: string;
+    }): Promise<{
+        chart: XTY[];
+        country: NameValue[];
+        total: {
+            sum: number;
+            count: number;
+            unique_count: number;
+            average: number;
+        };
+    }>;
+    /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports#post-apireportsutm (TODO UNTESTED) */
+    function postUTM(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps): Promise<{
+        utm_source: UTM[];
+        utm_medium: UTM[];
+        utm_campaign: UTM[];
+        utm_term: UTM[];
+        utm_content: UTM[];
+    }>;
+}

package/dist/namespaces/Reports.js

@@ -0,0 +1,70 @@
+/** Using reports throught the api: https://umami.is/docs/api/reports */
+export var Reports;
+(function (Reports) {
+    /** Get all reports by website ID: https://umami.is/docs/api/reports#get-apireports (TODO UNTESTED) */
+    async function get(websiteId, parameters) {
+        const response = await this.request("get", ["reports"], { websiteId, ...parameters });
+        return response.data;
+    }
+    Reports.get = get;
+    /** Creates a report: https://umami.is/docs/api/reports#post-apireports (TODO UNTESTED) */
+    async function post(websiteId, parameters) {
+        return await this.request("post", ["reports"], { websiteId, ...parameters });
+    }
+    Reports.post = post;
+    /** Gets a report by ID: https://umami.is/docs/api/reports#get-apireportsreportid (TODO UNTESTED) */
+    async function get_REPORTID(reportId) {
+        return await this.request("get", ["reports", reportId]);
+    }
+    Reports.get_REPORTID = get_REPORTID;
+    /** Updates a report: https://umami.is/docs/api/reports#post-apireportsreportid (TODO UNTESTED) */
+    async function post_REPORTID(reportId, websiteId, parameters) {
+        return await this.request("get", ["reports", reportId], { websiteId, ...parameters });
+    }
+    Reports.post_REPORTID = post_REPORTID;
+    /** Deletes a report: https://umami.is/docs/api/reports#delete-apireportsreportid (TODO UNTESTED) */
+    async function delete_REPORTID(reportId) {
+        return await this.request("delete", ["reports", reportId]);
+    }
+    Reports.delete_REPORTID = delete_REPORTID;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports#post-apireportsattribution (TODO UNTESTED) */
+    async function postAttribution(websiteId, parameters) {
+        return await this.request("post", ["reports", "attribution"], { websiteId, ...parameters });
+    }
+    Reports.postAttribution = postAttribution;
+    /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports#post-apireportsbreakdown (TODO UNTESTED) */
+    async function postBreakdown(websiteId, parameters) {
+        return await this.request("post", ["reports", "breakdown"], { websiteId, ...parameters });
+    }
+    Reports.postBreakdown = postBreakdown;
+    /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports#post-apireportsfunnel (TODO UNTESTED) */
+    async function postFunnel(websiteId, parameters) {
+        return await this.request("post", ["reports", "funnel"], { websiteId, ...parameters });
+    }
+    Reports.postFunnel = postFunnel;
+    /** Track your goals for pageviews and events: https://umami.is/docs/api/reports#post-apireportsgoals (TODO UNTESTED) */
+    async function postGoals(websiteId, parameters) {
+        return await this.request("post", ["reports", "goals"], { websiteId, ...parameters });
+    }
+    Reports.postGoals = postGoals;
+    /** Understand how users nagivate through your website: https://umami.is/docs/api/reports#post-apireportsjourney (TODO UNTESTED) */
+    async function postJourney(websiteId, parameters) {
+        return await this.request("post", ["reports", "journey"], { websiteId, ...parameters });
+    }
+    Reports.postJourney = postJourney;
+    /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports#post-apireportsretention (TODO UNTESTED) */
+    async function postRetention(websiteId, parameters) {
+        return await this.request("post", ["reports", "retention"], { websiteId, ...parameters });
+    }
+    Reports.postRetention = postRetention;
+    /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports#post-apireportsrevenue (TODO UNTESTED) */
+    async function postRevenue(websiteId, parameters) {
+        return await this.request("post", ["reports", "revenue"], { websiteId, ...parameters });
+    }
+    Reports.postRevenue = postRevenue;
+    /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports#post-apireportsutm (TODO UNTESTED) */
+    async function postUTM(websiteId, parameters) {
+        return await this.request("post", ["reports", "utm"], { websiteId, ...parameters });
+    }
+    Reports.postUTM = postUTM;
+})(Reports || (Reports = {}));