umami-api-js 0.0.4 → 0.1.1

package/README.md

@@ -1,4 +1,5 @@
-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).
+A package to interact with [the API of self-hosted instances of Umami v3.0.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 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.
+If you are reading this from the [package's documentation](https://umami-api-js.taevas.xyz/), please be aware that the documentation is for **umami-api-js@0.1.1**, so make sure your package is up to date! Report any bug on [Codeberg](https://codeberg.org/Taevas/umami-api-js/issues).
 
+Please note that this package is expected to work with self-hosted instances of **Umami v3.0.0**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
+import { Links } from "./namespaces/Links.js";
+import { Me } from "./namespaces/Me.js";
+import { Pixels } from "./namespaces/Pixels.js";
 import { Realtime } from "./namespaces/Realtime.js";
 import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
@@ -7,34 +10,28 @@ import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
 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 { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Teams, Users };
 export interface GenericObject {
     id: string;
     createdAt: Date;
     updatedAt: Date | null;
     deletedAt: Date | null;
 }
+export interface DeletionResult {
+    ok: boolean;
+}
 export interface Website extends GenericObject {
     name: string;
     domain: string;
     shareId: string | null;
     resetAt: Date | null;
-    userId: string;
+    /** @remarks Is null if the website is under a team (has a `teamId`) */
+    userId: Users.User["id"] | null;
     teamId: string | null;
-    createdBy: string;
+    createdBy: Users.User["id"];
 }
 export interface Report extends Omit<GenericObject, "deletedAt"> {
-    userId: string;
+    userId: Users.User["id"];
     websiteId: string;
     type: string;
     name: string;
@@ -62,6 +59,7 @@ export interface Timestamps {
     /** Timestamp of end date */
     endAt: Date | number;
 }
+/** An object with the properties `x`, `t`, and `y`, where they're respectively a name, a date, and an amount */
 export interface XTY {
     /** Event name */
     x: string;
@@ -104,7 +102,6 @@ export interface Filters {
     /** UUID of cohort */
     cohort?: string;
 }
-export type Role = "admin" | "user" | "view-only";
 export type TeamRole = "team-manager" | "team-member" | "team-view-only";
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export declare class APIError extends Error {
@@ -166,20 +163,8 @@ export declare class API {
     });
     private _user;
     /** Information about the account that has been used to log in */
-    get user(): {
-        id: string;
-        username: string;
-        role: string;
-        createdAt: Date;
-        isAdmin: boolean;
-    };
-    set user(user: {
-        id: string;
-        username: string;
-        role: string;
-        createdAt: Date;
-        isAdmin: boolean;
-    });
+    get user(): Users.User;
+    set user(user: Users.User);
     private number_of_requests;
     /** Has {@link API.setNewToken} been called and not yet returned anything? */
     private is_setting_token;
@@ -271,75 +256,185 @@ 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;
-        visits: ValueAndPrev;
-        bounces: ValueAndPrev;
-        totaltime: ValueAndPrev;
+    /**
+     * To register an event
+     * (TODO UNTESTED)
+     * @group Sending stats
+     */
+    sendStats(payload: {
+        /** Name of host */
+        hostname: string;
+        /** Screen resolution (ex. "1920x1080") */
+        screen: string;
+        /** Language of visitor (ex. "en-US") */
+        language: string;
+        /** Page URL */
+        url: string;
+        /** Referrer URL */
+        referrer: string;
+        /** Page title */
+        title: string;
+        /** Additional tag description */
+        tag: string;
+        /** Session identifier */
+        id: string;
+        /** Website ID */
+        website: string;
+        /** Name of the event */
+        name: string;
+        /** Additional data for the event */
+        data?: {
+            [k: string]: any;
+        };
+    }): Promise<{
+        cache: string;
+        sessionid: string;
+        visitId: string;
     }>;
+    /** @group Admin endpoints */
     readonly getUsersAsAdmin: typeof Admin.getUsers;
+    /** @group Admin endpoints */
     readonly getWebsitesAsAdmin: typeof Admin.getWebsites;
+    /** @group Admin endpoints */
     readonly getTeamsAsAdmin: typeof Admin.getTeams;
-    readonly createUser: typeof Users.createUser;
-    readonly getUser: typeof Users.getUser;
-    readonly updateUser: typeof Users.updateUser;
-    readonly deleteUser: typeof Users.deleteUser;
-    readonly getUserTeams: typeof Users.getUserTeams;
-    readonly getUserWebsites: typeof Users.getUserWebsites;
-    readonly getTeams: typeof Teams.getTeams;
-    readonly createTeam: typeof Teams.createTeam;
-    readonly joinTeam: typeof Teams.joinTeam;
-    readonly getTeam: typeof Teams.getTeam;
-    readonly updateTeam: typeof Teams.updateTeam;
-    readonly deleteTeam: typeof Teams.deleteTeam;
-    readonly getTeamUsers: typeof Teams.getTeamUsers;
-    readonly addTeamUser: typeof Teams.addTeamUser;
-    readonly getTeamUser: typeof Teams.getTeamUser;
-    readonly updateTeamUser: typeof Teams.updateTeamUser;
-    readonly removeTeamUser: typeof Teams.removeTeamUser;
-    readonly getTeamWebsites: typeof Teams.getTeamWebsites;
-    readonly getWebsiteEvents: typeof Events.getWebsiteEvents;
-    readonly getWebsiteEventData: typeof Events.getWebsiteEventData;
-    readonly getWebsiteEventsData: typeof Events.getWebsiteEventsData;
-    readonly getWebsiteEventsDataFields: typeof Events.getWebsiteEventsDataFields;
-    readonly getWebsiteEventsDataProperties: typeof Events.getWebsiteEventsDataProperties;
-    readonly getWebsiteEventsDataValues: typeof Events.getWebsiteEventsDataValues;
-    readonly getWebsiteEventsDataStats: typeof Events.getWebsiteEventsDataStats;
-    readonly getWebsiteSessions: typeof Sessions.getWebsiteSessions;
-    readonly getWebsiteSessionsStats: typeof Sessions.getWebsiteSessionsStats;
-    readonly getWebsiteSessionsWeekly: typeof Sessions.getWebsiteSessionsWeekly;
-    readonly getWebsiteSession: typeof Sessions.getWebsiteSession;
-    readonly getWebsiteSessionActivity: typeof Sessions.getWebsiteSessionActivity;
-    readonly getWebsiteSessionProperties: typeof Sessions.getWebsiteSessionProperties;
-    readonly getWebsiteSessionDataProperties: typeof Sessions.getWebsiteSessionDataProperties;
-    readonly getWebsiteSessionDataValues: typeof Sessions.getWebsiteSessionDataValues;
-    readonly getWebsites: typeof Websites.getWebsites;
-    readonly createWebsite: typeof Websites.createWebsite;
-    readonly getWebsite: typeof Websites.getWebsite;
-    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;
+    /** @group Events endpoints */
+    readonly getWebsiteEvents: typeof Events.get_WEBSITEID_Events;
+    /** @group Events endpoints */
+    readonly getWebsiteEventData: typeof Events.get_WEBSITEID_Eventdata_EVENTID;
+    /** @group Events endpoints */
+    readonly getWebsiteEventsData: typeof Events.get_WEBSITEID_EventdataEvents;
+    /** @group Events endpoints */
+    readonly getWebsiteEventsDataFields: typeof Events.get_WEBSITEID_EventdataFields;
+    /** @group Events endpoints */
+    readonly getWebsiteEventsDataProperties: typeof Events.get_WEBSITEID_EventdataProperties;
+    /** @group Events endpoints */
+    readonly getWebsiteEventsDataValues: typeof Events.get_WEBSITEID_EventdataValues;
+    /** @group Events endpoints */
+    readonly getWebsiteEventsDataStats: typeof Events.get_WEBSITEID_EventdataStats;
+    /** @group Links endpoints */
+    readonly getLinks: typeof Links.get;
+    /** @group Links endpoints */
+    readonly getLink: typeof Links.get_LINKID;
+    /** @group Links endpoints */
+    readonly updateLink: typeof Links.post_LINKID;
+    /** @group Links endpoints */
+    readonly deleteLink: typeof Links.delete_LINKID;
+    /** @group Me endpoints */
+    readonly getMyself: typeof Me.get;
+    /** @group Me endpoints */
+    readonly getMyTeams: typeof Me.getTeams;
+    /** @group Me endpoints */
+    readonly getMyWebsites: typeof Me.getWebsites;
+    /** @group Links endpoints */
+    readonly getPixels: typeof Pixels.get;
+    /** @group Links endpoints */
+    readonly getPixel: typeof Pixels.get_PIXELID;
+    /** @group Links endpoints */
+    readonly updatePixel: typeof Pixels.post_PIXELID;
+    /** @group Links endpoints */
+    readonly deletePixel: typeof Pixels.delete_PIXELID;
+    /** @group Websites endpoints */
+    readonly getWebsites: typeof Websites.get;
+    /** @group Websites endpoints */
+    readonly createWebsite: typeof Websites.post;
+    /** @group Websites endpoints */
+    readonly getWebsite: typeof Websites.get_WEBSITEID;
+    /** @group Websites endpoints */
+    readonly updateWebsite: typeof Websites.post_WEBSITEID;
+    /** @group Websites endpoints */
+    readonly deleteWebsite: typeof Websites.delete_WEBSITEID;
+    /** @group Websites endpoints */
+    readonly resetWebsite: typeof Websites.post_WEBSITEID_Reset;
+    /** @group Website stats endpoints */
+    readonly getWebsiteActiveVisitors: typeof WebsiteStats.get_WEBSITEID_Active;
+    /** @group Website stats endpoints */
+    readonly getWebsiteEventsStats: typeof WebsiteStats.get_WEBSITEID_EventsSeries;
+    /** @group Website stats endpoints */
+    readonly getWebsiteMetrics: typeof WebsiteStats.get_WEBSITEID_Metrics;
+    /** @group Website stats endpoints */
+    readonly getWebsiteMetricsExpanded: typeof WebsiteStats.get_WEBSITEID_MetricsExpanded;
+    /** @group Website stats endpoints */
+    readonly getWebsitePageviews: typeof WebsiteStats.get_WEBSITEID_Pageviews;
+    /** @group Website stats endpoints */
+    readonly getWebsiteStats: typeof WebsiteStats.get_WEBSITEID_Stats;
+    /** @group Realtime endpoints */
+    readonly getRealtime: typeof Realtime.get_WEBSITEID;
+    /** @group Reports endpoints */
+    readonly getReports: typeof Reports.get;
+    /** @group Reports endpoints */
+    readonly createReport: typeof Reports.post;
+    /** @group Reports endpoints */
+    readonly getReport: typeof Reports.get_REPORTID;
+    /** @group Reports endpoints */
+    readonly updateReport: typeof Reports.post_REPORTID;
+    /** @group Reports endpoints */
+    readonly deleteReport: typeof Reports.delete_REPORTID;
+    /** @group Reports endpoints */
+    readonly getReportsAttribution: typeof Reports.postAttribution;
+    /** @group Reports endpoints */
+    readonly getReportsBreakdown: typeof Reports.postBreakdown;
+    /** @group Reports endpoints */
+    readonly getReportsFunnel: typeof Reports.postFunnel;
+    /** @group Reports endpoints */
+    readonly getReportsGoals: typeof Reports.postGoals;
+    /** @group Reports endpoints */
+    readonly getReportsJourney: typeof Reports.postJourney;
+    /** @group Reports endpoints */
+    readonly getReportsRetention: typeof Reports.postRetention;
+    /** @group Reports endpoints */
+    readonly getReportsRevenue: typeof Reports.postRevenue;
+    /** @group Reports endpoints */
+    readonly getReportsUTM: typeof Reports.postUTM;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessions: typeof Sessions.get_WEBSITEID_Sessions;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionsStats: typeof Sessions.get_WEBSITEID_SessionsStats;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionsWeekly: typeof Sessions.get_WEBSITEID_SessionsWeekly;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSession: typeof Sessions.get_WEBSITEID_Sessions_SESSIONID;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionActivity: typeof Sessions.get_WEBSITEID_Sessions_SESSIONID_Activity;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionProperties: typeof Sessions.get_WEBSITEID_Sessions_SESSIONID_Properties;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionDataProperties: typeof Sessions.get_WEBSITEID_SessiondataProperties;
+    /** @group Sessions endpoints */
+    readonly getWebsiteSessionDataValues: typeof Sessions.get_WEBSITEID_SessiondataValues;
+    /** @group Teams endpoints */
+    readonly getTeams: typeof Teams.get;
+    /** @group Teams endpoints */
+    readonly createTeam: typeof Teams.post;
+    /** @group Teams endpoints */
+    readonly joinTeam: typeof Teams.postJoin;
+    /** @group Teams endpoints */
+    readonly getTeam: typeof Teams.get_TEAMID;
+    /** @group Teams endpoints */
+    readonly updateTeam: typeof Teams.post_TEAMID;
+    /** @group Teams endpoints */
+    readonly deleteTeam: typeof Teams.delete_TEAMID;
+    /** @group Teams endpoints */
+    readonly getTeamUsers: typeof Teams.get_TEAMID_Users;
+    /** @group Teams endpoints */
+    readonly addTeamUser: typeof Teams.post_TEAMID_Users;
+    /** @group Teams endpoints */
+    readonly getTeamUser: typeof Teams.get_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    readonly updateTeamUser: typeof Teams.post_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    readonly removeTeamUser: typeof Teams.delete_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    readonly getTeamWebsites: typeof Teams.get_TEAMID_Websites;
+    /** @group Users endpoints */
+    readonly createUser: typeof Users.post;
+    /** @group Users endpoints */
+    readonly getUser: typeof Users.get_USERID;
+    /** @group Users endpoints */
+    readonly updateUser: typeof Users.post_USERID;
+    /** @group Users endpoints */
+    readonly deleteUser: typeof Users.delete_USERID;
+    /** @group Users endpoints */
+    readonly getUserTeams: typeof Users.get_USERID_Teams;
+    /** @group Users endpoints */
+    readonly getUserWebsites: typeof Users.get_USERID_Websites;
 }

package/dist/index.js

@@ -1,5 +1,8 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
+import { Links } from "./namespaces/Links.js";
+import { Me } from "./namespaces/Me.js";
+import { Pixels } from "./namespaces/Pixels.js";
 import { Realtime } from "./namespaces/Realtime.js";
 import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
@@ -8,7 +11,7 @@ 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, WebsiteStats, Realtime, Reports };
+export { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Teams, Users };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -99,7 +102,7 @@ export class API {
     _user = {
         id: "",
         username: "",
-        role: "",
+        role: "view-only",
         createdAt: new Date(),
         isAdmin: false,
     };
@@ -134,8 +137,8 @@ export class API {
                         this.log(true, "Unable to obtain a token! Here's what was received from the API:", json);
                         reject(new APIError(error_message, this.server, "post", ["auth", "login"], body, response.status));
                     }
-                    this.token_type = json.token_type;
                     this.token = json.token;
+                    this.user = json.user;
                     const expiration_date = new Date();
                     expiration_date.setDate(expiration_date.getDate() + 1); // Assume 24 hours
                     this.expires = expiration_date;
@@ -378,80 +381,171 @@ 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 });
+    // UNCATEGORIZED
+    /**
+     * To register an event
+     * (TODO UNTESTED)
+     * @group Sending stats
+     */
+    async sendStats(payload) {
+        return await this.request("post", ["send"], { payload, type: "event" });
     }
     // ADMIN
+    /** @group Admin endpoints */
     getUsersAsAdmin = Admin.getUsers;
+    /** @group Admin endpoints */
     getWebsitesAsAdmin = Admin.getWebsites;
+    /** @group Admin endpoints */
     getTeamsAsAdmin = Admin.getTeams;
-    // USERS
-    createUser = Users.createUser;
-    getUser = Users.getUser;
-    updateUser = Users.updateUser;
-    deleteUser = Users.deleteUser;
-    getUserTeams = Users.getUserTeams;
-    getUserWebsites = Users.getUserWebsites;
-    // TEAMS
-    getTeams = Teams.getTeams;
-    createTeam = Teams.createTeam;
-    joinTeam = Teams.joinTeam;
-    getTeam = Teams.getTeam;
-    updateTeam = Teams.updateTeam;
-    deleteTeam = Teams.deleteTeam;
-    getTeamUsers = Teams.getTeamUsers;
-    addTeamUser = Teams.addTeamUser;
-    getTeamUser = Teams.getTeamUser;
-    updateTeamUser = Teams.updateTeamUser;
-    removeTeamUser = Teams.removeTeamUser;
-    getTeamWebsites = Teams.getTeamWebsites;
     // EVENTS
-    getWebsiteEvents = Events.getWebsiteEvents;
-    getWebsiteEventData = Events.getWebsiteEventData;
-    getWebsiteEventsData = Events.getWebsiteEventsData;
-    getWebsiteEventsDataFields = Events.getWebsiteEventsDataFields;
-    getWebsiteEventsDataProperties = Events.getWebsiteEventsDataProperties;
-    getWebsiteEventsDataValues = Events.getWebsiteEventsDataValues;
-    getWebsiteEventsDataStats = Events.getWebsiteEventsDataStats;
-    // SESSIONS
-    getWebsiteSessions = Sessions.getWebsiteSessions;
-    getWebsiteSessionsStats = Sessions.getWebsiteSessionsStats;
-    getWebsiteSessionsWeekly = Sessions.getWebsiteSessionsWeekly;
-    getWebsiteSession = Sessions.getWebsiteSession;
-    getWebsiteSessionActivity = Sessions.getWebsiteSessionActivity;
-    getWebsiteSessionProperties = Sessions.getWebsiteSessionProperties;
-    getWebsiteSessionDataProperties = Sessions.getWebsiteSessionDataProperties;
-    getWebsiteSessionDataValues = Sessions.getWebsiteSessionDataValues;
+    /** @group Events endpoints */
+    getWebsiteEvents = Events.get_WEBSITEID_Events;
+    /** @group Events endpoints */
+    getWebsiteEventData = Events.get_WEBSITEID_Eventdata_EVENTID;
+    /** @group Events endpoints */
+    getWebsiteEventsData = Events.get_WEBSITEID_EventdataEvents;
+    /** @group Events endpoints */
+    getWebsiteEventsDataFields = Events.get_WEBSITEID_EventdataFields;
+    /** @group Events endpoints */
+    getWebsiteEventsDataProperties = Events.get_WEBSITEID_EventdataProperties;
+    /** @group Events endpoints */
+    getWebsiteEventsDataValues = Events.get_WEBSITEID_EventdataValues;
+    /** @group Events endpoints */
+    getWebsiteEventsDataStats = Events.get_WEBSITEID_EventdataStats;
+    // LINKS
+    /** @group Links endpoints */
+    getLinks = Links.get;
+    /** @group Links endpoints */
+    getLink = Links.get_LINKID;
+    /** @group Links endpoints */
+    updateLink = Links.post_LINKID;
+    /** @group Links endpoints */
+    deleteLink = Links.delete_LINKID;
+    // ME
+    /** @group Me endpoints */
+    getMyself = Me.get;
+    /** @group Me endpoints */
+    getMyTeams = Me.getTeams;
+    /** @group Me endpoints */
+    getMyWebsites = Me.getWebsites;
+    // PIXELS
+    /** @group Links endpoints */
+    getPixels = Pixels.get;
+    /** @group Links endpoints */
+    getPixel = Pixels.get_PIXELID;
+    /** @group Links endpoints */
+    updatePixel = Pixels.post_PIXELID;
+    /** @group Links endpoints */
+    deletePixel = Pixels.delete_PIXELID;
     // WEBSITES
-    getWebsites = Websites.getWebsites;
-    createWebsite = Websites.createWebsite;
-    getWebsite = Websites.getWebsite;
-    updateWebsite = Websites.updateWebsite;
-    deleteWebsite = Websites.deleteWebsite;
-    resetWebsite = Websites.resetWebsite;
+    /** @group Websites endpoints */
+    getWebsites = Websites.get;
+    /** @group Websites endpoints */
+    createWebsite = Websites.post;
+    /** @group Websites endpoints */
+    getWebsite = Websites.get_WEBSITEID;
+    /** @group Websites endpoints */
+    updateWebsite = Websites.post_WEBSITEID;
+    /** @group Websites endpoints */
+    deleteWebsite = Websites.delete_WEBSITEID;
+    /** @group Websites endpoints */
+    resetWebsite = Websites.post_WEBSITEID_Reset;
     // 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;
+    /** @group Website stats endpoints */
+    getWebsiteActiveVisitors = WebsiteStats.get_WEBSITEID_Active;
+    /** @group Website stats endpoints */
+    getWebsiteEventsStats = WebsiteStats.get_WEBSITEID_EventsSeries;
+    /** @group Website stats endpoints */
+    getWebsiteMetrics = WebsiteStats.get_WEBSITEID_Metrics;
+    /** @group Website stats endpoints */
+    getWebsiteMetricsExpanded = WebsiteStats.get_WEBSITEID_MetricsExpanded;
+    /** @group Website stats endpoints */
+    getWebsitePageviews = WebsiteStats.get_WEBSITEID_Pageviews;
+    /** @group Website stats endpoints */
+    getWebsiteStats = WebsiteStats.get_WEBSITEID_Stats;
     // REALTIME
-    getRealtime = Realtime.getRealtime;
+    /** @group Realtime endpoints */
+    getRealtime = Realtime.get_WEBSITEID;
     // 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;
+    /** @group Reports endpoints */
+    getReports = Reports.get;
+    /** @group Reports endpoints */
+    createReport = Reports.post;
+    /** @group Reports endpoints */
+    getReport = Reports.get_REPORTID;
+    /** @group Reports endpoints */
+    updateReport = Reports.post_REPORTID;
+    /** @group Reports endpoints */
+    deleteReport = Reports.delete_REPORTID;
+    /** @group Reports endpoints */
+    getReportsAttribution = Reports.postAttribution;
+    /** @group Reports endpoints */
+    getReportsBreakdown = Reports.postBreakdown;
+    /** @group Reports endpoints */
+    getReportsFunnel = Reports.postFunnel;
+    /** @group Reports endpoints */
+    getReportsGoals = Reports.postGoals;
+    /** @group Reports endpoints */
+    getReportsJourney = Reports.postJourney;
+    /** @group Reports endpoints */
+    getReportsRetention = Reports.postRetention;
+    /** @group Reports endpoints */
+    getReportsRevenue = Reports.postRevenue;
+    /** @group Reports endpoints */
+    getReportsUTM = Reports.postUTM;
+    // SESSIONS
+    /** @group Sessions endpoints */
+    getWebsiteSessions = Sessions.get_WEBSITEID_Sessions;
+    /** @group Sessions endpoints */
+    getWebsiteSessionsStats = Sessions.get_WEBSITEID_SessionsStats;
+    /** @group Sessions endpoints */
+    getWebsiteSessionsWeekly = Sessions.get_WEBSITEID_SessionsWeekly;
+    /** @group Sessions endpoints */
+    getWebsiteSession = Sessions.get_WEBSITEID_Sessions_SESSIONID;
+    /** @group Sessions endpoints */
+    getWebsiteSessionActivity = Sessions.get_WEBSITEID_Sessions_SESSIONID_Activity;
+    /** @group Sessions endpoints */
+    getWebsiteSessionProperties = Sessions.get_WEBSITEID_Sessions_SESSIONID_Properties;
+    /** @group Sessions endpoints */
+    getWebsiteSessionDataProperties = Sessions.get_WEBSITEID_SessiondataProperties;
+    /** @group Sessions endpoints */
+    getWebsiteSessionDataValues = Sessions.get_WEBSITEID_SessiondataValues;
+    // TEAMS
+    /** @group Teams endpoints */
+    getTeams = Teams.get;
+    /** @group Teams endpoints */
+    createTeam = Teams.post;
+    /** @group Teams endpoints */
+    joinTeam = Teams.postJoin;
+    /** @group Teams endpoints */
+    getTeam = Teams.get_TEAMID;
+    /** @group Teams endpoints */
+    updateTeam = Teams.post_TEAMID;
+    /** @group Teams endpoints */
+    deleteTeam = Teams.delete_TEAMID;
+    /** @group Teams endpoints */
+    getTeamUsers = Teams.get_TEAMID_Users;
+    /** @group Teams endpoints */
+    addTeamUser = Teams.post_TEAMID_Users;
+    /** @group Teams endpoints */
+    getTeamUser = Teams.get_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    updateTeamUser = Teams.post_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    removeTeamUser = Teams.delete_TEAMID_Users_USERID;
+    /** @group Teams endpoints */
+    getTeamWebsites = Teams.get_TEAMID_Websites;
+    // USERS
+    /** @group Users endpoints */
+    createUser = Users.post;
+    /** @group Users endpoints */
+    getUser = Users.get_USERID;
+    /** @group Users endpoints */
+    updateUser = Users.post_USERID;
+    /** @group Users endpoints */
+    deleteUser = Users.delete_USERID;
+    /** @group Users endpoints */
+    getUserTeams = Users.get_USERID_Teams;
+    /** @group Users endpoints */
+    getUserWebsites = Users.get_USERID_Websites;
 }