umami-api-js 0.0.3 → 0.0.4

package/README.md

@@ -1,5 +1,4 @@
 A package to interact with [the API of self-hosted instances of Umami v2.19.0](https://umami.is/docs/api). It is a lightweight alternative to [@umami/api-client](https://github.com/umami-software/api-client), forked from [osu-api-v2-js](https://github.com/TTTaevas/osu-api-v2-js).
 
-Please note that this package is not expected to work with Umami Cloud, the instance of Umami hosted by its creators.
+Please note that this package is expected to work with self-hosted instances of **Umami v2.19.0**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.
 
-Please also note that this is currently being built mainly to serve as a component to my [taevas.xyz](https://codeberg.org/Taevas/taevas.xyz) project, meaning it currently doesn't perfectly cover the API!

package/dist/index.d.ts

@@ -1,23 +1,53 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
-export { Admin, Users, Teams, Events, Sessions, Websites, Realtime };
+import { WebsiteStats } from "./namespaces/WebsiteStats.js";
+export { Admin, Users, Teams, Events, Sessions, Websites, WebsiteStats, Realtime, Reports };
 export interface ValueAndPrev {
     /** The actual value for the given time period */
     value: number;
     /** The value for the same *timespan* for the time period that ends where the time period for value starts  */
     prev: number;
 }
+export interface MinimalUser {
+    id: string;
+    username: string;
+}
 export interface GenericObject {
     id: string;
     createdAt: Date;
     updatedAt: Date | null;
     deletedAt: Date | null;
 }
+export interface Website extends GenericObject {
+    name: string;
+    domain: string;
+    shareId: string | null;
+    resetAt: Date | null;
+    userId: string;
+    teamId: string | null;
+    createdBy: string;
+}
+export interface Report extends Omit<GenericObject, "deletedAt"> {
+    userId: string;
+    websiteId: string;
+    type: string;
+    name: string;
+    description: string;
+    parameters: {
+        type: string;
+        value: string;
+    };
+}
+export interface NameValue {
+    name: string;
+    value: number;
+}
 export interface GenericRequestParameters {
     /** Search text */
     search?: string;
@@ -32,9 +62,17 @@ export interface Timestamps {
     /** Timestamp of end date */
     endAt: Date | number;
 }
+export interface XTY {
+    /** Event name */
+    x: string;
+    /** Timestamp */
+    t: Date;
+    /** Number of events */
+    y: number;
+}
 /**
  * Many endpoints can make use of the filters in this interface
- * @remarks As defined in the server documentation for the Endpoints in: Events, Sessions, Website stats
+ * @remarks As defined in the server documentation for the Endpoints in: Events, Sessions, Website stats, Reports
  */
 export interface Filters {
     /** Name of URL */
@@ -148,9 +186,9 @@ export declare class API {
     /** If {@link API.setNewToken} has been called, you can wait for it to be done through this promise */
     private token_promise;
     /**
-     * This creates a new {@link API.token}, alongside a new {@link API.refresh_token} if arguments are provided or if a refresh_token already exists
+     * This contacts the server in order to get and set a new {@link API.token}!
      * @remarks The API object requires a {@link API.username} and a {@link API.password} to successfully get any token
-     * @returns Whether or not the token has changed (this should never throw)
+     * @returns Whether or not the token has changed (**should be true** as otherwise the server would complain and an {@link APIError} would be thrown to give you some details)
      */
     setNewToken(): Promise<boolean>;
     private _set_token_on_401;
@@ -233,6 +271,7 @@ export declare class API {
     request(method: "get" | "post" | "put" | "delete", endpoint: Array<string | number>, parameters?: {
         [k: string]: any;
     }): Promise<any>;
+    /** @remarks To be replaced by {@link API.getWebsiteStats2}, no deprecation warning as the new method is unreliable */
     getWebsiteStats(website_id: string, startAt: Date, endAt: Date): Promise<{
         pageviews: ValueAndPrev;
         visitors: ValueAndPrev;
@@ -282,5 +321,25 @@ export declare class API {
     readonly updateWebsite: typeof Websites.updateWebsite;
     readonly deleteWebsite: typeof Websites.deleteWebsite;
     readonly resetWebsite: typeof Websites.resetWebsite;
+    readonly getWebsiteActiveVisitors: typeof WebsiteStats.getWebsiteActiveVisitors;
+    readonly getWebsiteEventsStats: typeof WebsiteStats.getWebsiteEvents;
+    readonly getWebsiteMetrics: typeof WebsiteStats.getWebsiteMetrics;
+    readonly getWebsiteMetricsExpanded: typeof WebsiteStats.getWebsiteMetricsExpanded;
+    readonly getWebsitePageviews: typeof WebsiteStats.getWebsitePageviews;
+    /** @remarks Will replace {@link API.getWebsiteStats}, which you should use for a reliable experience */
+    readonly getWebsiteStats2: typeof WebsiteStats.getWebsiteStats;
     readonly getRealtime: typeof Realtime.getRealtime;
+    readonly getReports: typeof Reports.getReports;
+    readonly createReport: typeof Reports.createReport;
+    readonly getReport: typeof Reports.getReport;
+    readonly updateReport: typeof Reports.updateReport;
+    readonly deleteReport: typeof Reports.deleteReport;
+    readonly getReportsAttribution: typeof Reports.getReportsAttribution;
+    readonly getReportsBreakdown: typeof Reports.getReportsBreakdown;
+    readonly getReportsFunnel: typeof Reports.getReportsFunnel;
+    readonly getReportsGoals: typeof Reports.getReportsGoals;
+    readonly getReportsJourney: typeof Reports.getReportsJourney;
+    readonly getReportsRetention: typeof Reports.getReportsRetention;
+    readonly getReportsRevenue: typeof Reports.getReportsRevenue;
+    readonly getReportsUTM: typeof Reports.getReportsUTM;
 }

package/dist/index.js

@@ -1,12 +1,14 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
+import { WebsiteStats } from "./namespaces/WebsiteStats.js";
 import { adaptParametersForGETRequests, correctType } from "./utilities.js";
-export { Admin, Users, Teams, Events, Sessions, Websites, Realtime };
+export { Admin, Users, Teams, Events, Sessions, Websites, WebsiteStats, Realtime, Reports };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -111,9 +113,9 @@ export class API {
     /** If {@link API.setNewToken} has been called, you can wait for it to be done through this promise */
     token_promise = new Promise(r => r);
     /**
-     * This creates a new {@link API.token}, alongside a new {@link API.refresh_token} if arguments are provided or if a refresh_token already exists
+     * This contacts the server in order to get and set a new {@link API.token}!
      * @remarks The API object requires a {@link API.username} and a {@link API.password} to successfully get any token
-     * @returns Whether or not the token has changed (this should never throw)
+     * @returns Whether or not the token has changed (**should be true** as otherwise the server would complain and an {@link APIError} would be thrown to give you some details)
      */
     async setNewToken() {
         const old_token = this.token;
@@ -376,6 +378,7 @@ export class API {
             throw new APIError(`${e?.name} (${e?.message ?? e?.errno ?? e?.type})`, this.server, method, endpoint, parameters, undefined, e);
         }
     }
+    /** @remarks To be replaced by {@link API.getWebsiteStats2}, no deprecation warning as the new method is unreliable */
     async getWebsiteStats(website_id, startAt, endAt) {
         return await this.request("get", ["websites", website_id, "stats"], { startAt, endAt });
     }
@@ -427,6 +430,28 @@ export class API {
     updateWebsite = Websites.updateWebsite;
     deleteWebsite = Websites.deleteWebsite;
     resetWebsite = Websites.resetWebsite;
+    // WEBSITE STATS
+    getWebsiteActiveVisitors = WebsiteStats.getWebsiteActiveVisitors;
+    getWebsiteEventsStats = WebsiteStats.getWebsiteEvents;
+    getWebsiteMetrics = WebsiteStats.getWebsiteMetrics;
+    getWebsiteMetricsExpanded = WebsiteStats.getWebsiteMetricsExpanded;
+    getWebsitePageviews = WebsiteStats.getWebsitePageviews;
+    /** @remarks Will replace {@link API.getWebsiteStats}, which you should use for a reliable experience */
+    getWebsiteStats2 = WebsiteStats.getWebsiteStats;
     // REALTIME
     getRealtime = Realtime.getRealtime;
+    // REPORTS
+    getReports = Reports.getReports;
+    createReport = Reports.createReport;
+    getReport = Reports.getReport;
+    updateReport = Reports.updateReport;
+    deleteReport = Reports.deleteReport;
+    getReportsAttribution = Reports.getReportsAttribution;
+    getReportsBreakdown = Reports.getReportsBreakdown;
+    getReportsFunnel = Reports.getReportsFunnel;
+    getReportsGoals = Reports.getReportsGoals;
+    getReportsJourney = Reports.getReportsJourney;
+    getReportsRetention = Reports.getReportsRetention;
+    getReportsRevenue = Reports.getReportsRevenue;
+    getReportsUTM = Reports.getReportsUTM;
 }

package/dist/namespaces/Admin.d.ts

@@ -1,4 +1,4 @@
-import { API, GenericObject, GenericRequestParameters, Role, Teams } from "../index.js";
+import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, Teams, Website } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/admin-api */
 export declare namespace Admin {
     /** Returns all users: https://umami.is/docs/api/admin-api#get-apiadminusers */
@@ -18,18 +18,8 @@ export declare namespace Admin {
      * Returns all websites: https://umami.is/docs/api/admin-api#get-apiadminwebsites
      * @remarks TODO Possibly doesn't work? (throws 400 on my end)
      */
-    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: number | null;
-        resetAt: Date | null;
-        userId: string;
-        teamid: string | null;
-        createdBy: string;
-        user: {
-            username: string;
-            id: string;
-        };
+    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Website & {
+        user: MinimalUser;
         /** @remarks TODO Documentation says it can be null but doesn't actually say what else it can be, ***presumed* to be string**, check */
         team: string | null;
     })[]>;

package/dist/namespaces/Reports.d.ts

@@ -0,0 +1,146 @@
+import { API, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/reports-api */
+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-api#get-apireports (TODO UNTESTED) */
+    function getReports(this: API, websiteId: string, parameters: ReportType & Omit<GenericRequestParameters, "search">): Promise<Report[]>;
+    /** Creates a report: https://umami.is/docs/api/reports-api#post-apireports (TODO UNTESTED) */
+    function createReport(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-api#get-apireportsreportid (TODO UNTESTED) */
+    function getReport(this: API, reportId: string): Promise<Report>;
+    /** Updates a report: https://umami.is/docs/api/reports-api#post-apireportsreportid (TODO UNTESTED) */
+    function updateReport(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-api#delete-apireportsreportid (TODO UNTESTED) */
+    function deleteReport(this: API, reportId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports-api#post-apireportsattribution (TODO UNTESTED) */
+    function getReportsAttribution(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-api#post-apireportsbreakdown (TODO UNTESTED) */
+    function getReportsBreakdown(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-api#post-apireportsfunnel (TODO UNTESTED) */
+    function getReportsFunnel(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-api#post-apireportsgoals (TODO UNTESTED) */
+    function getReportsGoals(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-api#post-apireportsjourney (TODO UNTESTED) */
+    function getReportsJourney(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-api#post-apireportsretention (TODO UNTESTED) */
+    function getReportsRetention(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-api#post-apireportsrevenue (TODO UNTESTED) */
+    function getReportsRevenue(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-api#post-apireportsutm (TODO UNTESTED) */
+    function getReportsUTM(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 @@
+/** For endpoints listed on: https://umami.is/docs/api/reports-api */
+export var Reports;
+(function (Reports) {
+    /** Get all reports by website ID: https://umami.is/docs/api/reports-api#get-apireports (TODO UNTESTED) */
+    async function getReports(websiteId, parameters) {
+        const response = await this.request("get", ["reports"], { websiteId, ...parameters });
+        return response.data;
+    }
+    Reports.getReports = getReports;
+    /** Creates a report: https://umami.is/docs/api/reports-api#post-apireports (TODO UNTESTED) */
+    async function createReport(websiteId, parameters) {
+        return await this.request("post", ["reports"], { websiteId, ...parameters });
+    }
+    Reports.createReport = createReport;
+    /** Gets a report by ID: https://umami.is/docs/api/reports-api#get-apireportsreportid (TODO UNTESTED) */
+    async function getReport(reportId) {
+        return await this.request("get", ["reports", reportId]);
+    }
+    Reports.getReport = getReport;
+    /** Updates a report: https://umami.is/docs/api/reports-api#post-apireportsreportid (TODO UNTESTED) */
+    async function updateReport(reportId, websiteId, parameters) {
+        return await this.request("get", ["reports", reportId], { websiteId, ...parameters });
+    }
+    Reports.updateReport = updateReport;
+    /** Deletes a report: https://umami.is/docs/api/reports-api#delete-apireportsreportid (TODO UNTESTED) */
+    async function deleteReport(reportId) {
+        return await this.request("delete", ["reports", reportId]);
+    }
+    Reports.deleteReport = deleteReport;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports-api#post-apireportsattribution (TODO UNTESTED) */
+    async function getReportsAttribution(websiteId, parameters) {
+        return await this.request("post", ["reports", "attribution"], { websiteId, ...parameters });
+    }
+    Reports.getReportsAttribution = getReportsAttribution;
+    /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports-api#post-apireportsbreakdown (TODO UNTESTED) */
+    async function getReportsBreakdown(websiteId, parameters) {
+        return await this.request("post", ["reports", "breakdown"], { websiteId, ...parameters });
+    }
+    Reports.getReportsBreakdown = getReportsBreakdown;
+    /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports-api#post-apireportsfunnel (TODO UNTESTED) */
+    async function getReportsFunnel(websiteId, parameters) {
+        return await this.request("post", ["reports", "funnel"], { websiteId, ...parameters });
+    }
+    Reports.getReportsFunnel = getReportsFunnel;
+    /** Track your goals for pageviews and events: https://umami.is/docs/api/reports-api#post-apireportsgoals (TODO UNTESTED) */
+    async function getReportsGoals(websiteId, parameters) {
+        return await this.request("post", ["reports", "goals"], { websiteId, ...parameters });
+    }
+    Reports.getReportsGoals = getReportsGoals;
+    /** Understand how users nagivate through your website: https://umami.is/docs/api/reports-api#post-apireportsjourney (TODO UNTESTED) */
+    async function getReportsJourney(websiteId, parameters) {
+        return await this.request("post", ["reports", "journey"], { websiteId, ...parameters });
+    }
+    Reports.getReportsJourney = getReportsJourney;
+    /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports-api#post-apireportsretention (TODO UNTESTED) */
+    async function getReportsRetention(websiteId, parameters) {
+        return await this.request("post", ["reports", "retention"], { websiteId, ...parameters });
+    }
+    Reports.getReportsRetention = getReportsRetention;
+    /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports-api#post-apireportsrevenue (TODO UNTESTED) */
+    async function getReportsRevenue(websiteId, parameters) {
+        return await this.request("post", ["reports", "revenue"], { websiteId, ...parameters });
+    }
+    Reports.getReportsRevenue = getReportsRevenue;
+    /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports-api#post-apireportsutm (TODO UNTESTED) */
+    async function getReportsUTM(websiteId, parameters) {
+        return await this.request("post", ["reports", "utm"], { websiteId, ...parameters });
+    }
+    Reports.getReportsUTM = getReportsUTM;
+})(Reports || (Reports = {}));

package/dist/namespaces/Users.d.ts

@@ -1,9 +1,7 @@
-import { API, GenericObject, GenericRequestParameters, Role, TeamRole } from "../index.js";
+import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, TeamRole, Website } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/users-api */
 export declare namespace Users {
-    interface GenericUser {
-        id: string;
-        username: string;
+    interface GenericUser extends MinimalUser {
         role: Role;
     }
     /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
@@ -39,18 +37,8 @@ export declare namespace Users {
     /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
     function getUserWebsites(this: API, id: string, parameters: GenericRequestParameters & {
         includeTeams: boolean;
-    }): Promise<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: string | null;
-        resetAt: Date | null;
-        userId: string;
-        teamId: string | null;
-        createdBy: string;
-        user: {
-            username: string;
-            id: string;
-        };
+    }): Promise<(Website & {
+        user: MinimalUser;
     })[]>;
     /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
     function getUserTeams(this: API, id: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {

package/dist/namespaces/WebsiteStats.d.ts

@@ -0,0 +1,90 @@
+import { API, Filters, Timestamps, XTY } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/website-stats-api */
+export declare namespace WebsiteStats {
+    /**
+     * The unit parameter buckets the data returned
+     * @remarks The unit is automatically converted to the next largest applicable time unit if the maximum is exceeded
+     */
+    interface Units {
+        /** Up to 60 minutes */
+        minute?: number;
+        /** Up to 48 hours */
+        hour?: number;
+        /** Up to 12 months */
+        day?: number;
+        /** No limit */
+        month?: number;
+        /** No limit */
+        year?: number;
+    }
+    interface Stats {
+        /** Pages hits */
+        pageviews: string;
+        /** Number of unique visitors */
+        visitors: string;
+        /** Number of unique visits */
+        visits: string;
+        /** Number of visitors who only visit a single page */
+        bounces: string;
+        /** Time spent on the website */
+        totaltime: string;
+    }
+    type MetricsTypes = "path" | "entry" | "exit" | "title" | "query" | "referrer" | "channel" | "domain" | "country" | "region" | "city" | "browser" | "os" | "device" | "language" | "screen" | "event" | "hostname" | "tag";
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    function getWebsiteActiveVisitors(this: API, websiteId: string): Promise<{
+        visitors: number;
+    }>;
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    function getWebsiteEvents(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<XTY[]>;
+    /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
+    function getWebsiteMetrics(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Metrics type */
+        type: MetricsTypes;
+        /** (optional, default 500) Number of rows returned */
+        limit?: number;
+        /** (optional, default 0) Number of ows to skip */
+        offset?: number;
+    }): Promise<{
+        /** Unique value, depending on metric type */
+        x: string;
+        /** Number of visitors */
+        y: number;
+    }[]>;
+    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
+    function getWebsiteMetricsExpanded(this: API, ...args: Parameters<typeof getWebsiteMetrics>): Promise<(Stats & {
+        /** Unique value, depending on metric type */
+        name: string;
+    })[]>;
+    /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
+    function getWebsitePageviews(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Comparison value `prev` | `yoy` */
+        compare?: string;
+    }): Promise<{
+        pageviews: {
+            /** Timestamp */
+            x: Date;
+            /** Number of pageviews or visitors */
+            y: number;
+        }[];
+        sessions: {
+            /** Timestamp */
+            x: Date;
+            /** Number of pageviews or visitors */
+            y: number;
+        }[];
+    }>;
+    /** Gets summarized website statistics: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
+    function getWebsiteStats(this: API, websiteId: string, parameters: Timestamps & Filters & Units & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<Stats & {
+        comparison: Stats;
+    }>;
+}

package/dist/namespaces/WebsiteStats.js

@@ -0,0 +1,34 @@
+/** For endpoints listed on: https://umami.is/docs/api/website-stats-api */
+export var WebsiteStats;
+(function (WebsiteStats) {
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    async function getWebsiteActiveVisitors(websiteId) {
+        return await this.request("get", ["websites", websiteId, "active"]);
+    }
+    WebsiteStats.getWebsiteActiveVisitors = getWebsiteActiveVisitors;
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    async function getWebsiteEvents(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+    }
+    WebsiteStats.getWebsiteEvents = getWebsiteEvents;
+    /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
+    async function getWebsiteMetrics(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "metrics"], parameters);
+    }
+    WebsiteStats.getWebsiteMetrics = getWebsiteMetrics;
+    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
+    async function getWebsiteMetricsExpanded(...args) {
+        return await this.request("get", ["websites", args[0], "metrics", "expanded"], args[1]);
+    }
+    WebsiteStats.getWebsiteMetricsExpanded = getWebsiteMetricsExpanded;
+    /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
+    async function getWebsitePageviews(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "pageviews"], parameters);
+    }
+    WebsiteStats.getWebsitePageviews = getWebsitePageviews;
+    /** Gets summarized website statistics: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
+    async function getWebsiteStats(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "stats"], parameters);
+    }
+    WebsiteStats.getWebsiteStats = getWebsiteStats;
+})(WebsiteStats || (WebsiteStats = {}));

package/dist/namespaces/Websites.d.ts

@@ -1,10 +1,12 @@
-import { API, GenericRequestParameters } from "../index.js";
+import { API, GenericRequestParameters, MinimalUser, Website } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/websites-api */
 export declare namespace Websites {
     /** Returns all user websites: https://umami.is/docs/api/websites-api#get-apiwebsites (TODO UNTESTED) */
     function getWebsites(this: API, parameters: GenericRequestParameters & {
         includeTeams: boolean;
-    }): Promise<any[]>;
+    }): Promise<(Website & {
+        user: MinimalUser;
+    })[]>;
     /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
     function createWebsite(this: API, parameters: {
         /** The name of the website in Umami */
@@ -17,9 +19,9 @@ export declare namespace Websites {
         teamId?: string;
         /** Force a UUID assignment to the website */
         id?: string;
-    }): Promise<any>;
+    }): Promise<Website>;
     /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
-    function getWebsite(this: API, websiteId: string): Promise<any>;
+    function getWebsite(this: API, websiteId: string): Promise<Website>;
     /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
     function updateWebsite(this: API, websiteId: string, parameters: {
         /** The name of the website in Umami */
@@ -28,7 +30,7 @@ export declare namespace Websites {
         domain: string;
         /** A unique string to enable a share url. Set `null` to unshare */
         shareId?: string | null;
-    }): Promise<any>;
+    }): Promise<Website>;
     /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
     function deleteWebsite(this: API, websiteId: string): Promise<{
         ok: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",

package/.forgejo/workflows/release.yaml

@@ -1,33 +0,0 @@
-on:
-  release:
-    types: [published]
-
-jobs:
-  docs:
-    runs-on: codeberg-tiny-lazy
-    steps:
-      - name: Checkout this very app
-        uses: actions/checkout@v4
-      - name: Install dependencies
-        run: npm install
-      - name: Generate documentation through the command defined in package.json
-        run: npm run docs
-      - name: Move the docs up and get rid of the rest (this preserves files that start with a dot)
-        run: |
-          mv docs/ ..
-          rm -rf *
-          mv ../docs/* .
-      - name: Add the .domains file
-        run: echo "umami-api-js.taevas.xyz" > .domains
-      - name: Configure our git client
-        run: |
-          git config user.name "forgejo-actions[bot]"
-          git config user.email "code@taevas.xyz"
-      - name: Create or switch to the "pages" branch
-        run: git switch -C pages
-      - name: Add and commit the changes
-        run: |
-          git add .
-          git commit -m "Automatically generated documentation"
-      - name: Send the changes to Codeberg, let Codeberg Pages do its magic~
-        run: git push