@dt-esa/dynatrace-api-client - npm Package Compare versions

Comparing version 2.2.6 to 2.2.7

dist/api/env-v1.d.ts

 import { DynatraceConnection } from "../types/dynatrace-connection";
 import { APIOptions } from "../types/options";
-import { internalEnvV1 as EnvironmentV1 } from "./generated/env-v1";
+import { internalEnvV1 as EnvironmentV1, UserSession, UserSessionErrors, UserSessionEvents, UserSessionUserAction } from "./generated/env-v1";
+declare type UserAction = UserSessionUserAction & {
+    "usersession.userSessionId": string;
+};
+declare type UserEvent = UserSessionEvents & {
+    "usersession.userSessionId": string;
+};
+declare type UserError = UserSessionErrors & {
+    "usersession.userSessionId": string;
+};
 /**
@@ -17,5 +26,140 @@ * @title Dynatrace Environment API
     constructor(connection: DynatraceConnection, options?: APIOptions);
-    private readonly usql;
-    userSessionQueryLanguage: any;
+    userSessionQueryLanguage: {
+        /**
+         * A method to return all user sessions from a tenant in the specified timeframe.
+         * Caveats:
+         * - Your WHERE filter may not use "startTime" filtering. This keyword is reserved for the
+         * result querying mechanism.
+         * - This does NOT work with aggregations, FUNNEL, or other transformative filters.
+         * - Due to the way this works, querying can load very large volumes of data (GB range)
+         * for large RUM datasets. We do not yet offer a "stream" or otherwise dynamic option of this functionality.
+         * @param query.customMetrics additional custom properties to "SELECT".
+         * This is an array of properties that follows the pattern `stringProperties.username as "Username"`.
+         * Can be used in conjunction with dynamic types like so:
+         * ```
+         *  api.userSessionQueryLanguage.getAllUserSessions<{"stringProperties.username": string}>(...args)
+         * ```
+         * @param query.usqlFilter "WHERE" portion of a USQL call. Do not include the "WHERE" text.
+         * @param query.startTimestamp Unix start timestamp of window to pull USQL data. Defaults to 2 hours ago.
+         * @param query.endTimestamp   Unix end timestamp of window to pull USQL data. Defaults to now.
+         * @param requestArgs
+         *
+         */
+        getAllUserSessions: <T = {}>(query: {
+            customMetrics?: string[];
+            usqlFilter?: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+        }, requestArgs?: any) => Promise<(UserSession & T)[]>;
+        /**
+         * A method to return all user actions from a tenant in the specified timeframe.
+         * Caveats:
+         * - Your WHERE filter may not use "startTime" filtering. This keyword is reserved for the
+         * result querying mechanism.
+         * - This does NOT work with aggregations, FUNNEL, or other transformative filters.
+         * - Due to the way this works, querying can load very large volumes of data (GB range)
+         * for large RUM datasets. We do not yet offer a "stream" or otherwise dynamic option of this functionality.
+         * @param query.customMetrics additional custom properties to "SELECT".
+         * This is an array of properties that follows the pattern `stringProperties.username as "Username"`.
+         * Can be used in conjunction with dynamic types like so:
+         * ```
+         *  api.userSessionQueryLanguage.getAllUserActions<{"stringProperties.username": string}>(...args)
+         * ```
+         * @param query.usqlFilter "WHERE" portion of a USQL call. Do not include the "WHERE" text.
+         * @param query.startTimestamp Unix start timestamp of window to pull USQL data. Defaults to 2 hours ago.
+         * @param query.endTimestamp   Unix end timestamp of window to pull USQL data. Defaults to now.
+         * @param requestArgs
+         *
+         */
+        getAllUserActions: <T_1 = {}>(query: {
+            customMetrics?: string[];
+            usqlFilter?: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+        }, requestArgs?: any) => Promise<(UserSessionUserAction & {
+            "usersession.userSessionId": string;
+        } & T_1)[]>;
+        /**
+         * A method to return all user events from a tenant in the specified timeframe.
+         * Caveats:
+         * - Your WHERE filter may not use "startTime" filtering. This keyword is reserved for the
+         * result querying mechanism.
+         * - This does NOT work with aggregations, FUNNEL, or other transformative filters.
+         * - Due to the way this works, querying can load very large volumes of data (GB range)
+         * for large RUM datasets. We do not yet offer a "stream" or otherwise dynamic option of this functionality.
+         * @param query.customMetrics additional custom properties to "SELECT".
+         * This is an array of properties that follows the pattern `stringProperties.username as "Username"`.
+         * Can be used in conjunction with dynamic types like so:
+         * ```
+         *  api.userSessionQueryLanguage.getAllUserEvents<{"stringProperties.username": string}>(...args)
+         * ```
+         * @param query.usqlFilter "WHERE" portion of a USQL call. Do not include the "WHERE" text.
+         * @param query.startTimestamp Unix start timestamp of window to pull USQL data. Defaults to 2 hours ago.
+         * @param query.endTimestamp   Unix end timestamp of window to pull USQL data. Defaults to now.
+         * @param requestArgs
+         *
+         */
+        getAllUserEvents: <T_2 = {}>(query: {
+            customMetrics?: string[];
+            usqlFilter?: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+        }, requestArgs?: any) => Promise<(UserSessionEvents & {
+            "usersession.userSessionId": string;
+        } & T_2)[]>;
+        /**
+         * A method to return all user errors from a tenant in the specified timeframe.
+         * Caveats:
+         * - Your WHERE filter may not use "startTime" filtering. This keyword is reserved for the
+         * result querying mechanism.
+         * - This does NOT work with aggregations, FUNNEL, or other transformative filters.
+         * - Due to the way this works, querying can load very large volumes of data (GB range)
+         * for large RUM datasets. We do not yet offer a "stream" or otherwise dynamic option of this functionality.
+         * @param query.customMetrics additional custom properties to "SELECT".
+         * This is an array of properties that follows the pattern `stringProperties.username as "Username"`.
+         * Can be used in conjunction with dynamic types like so:
+         * ```
+         *  api.userSessionQueryLanguage.getAllUserErrors<{"stringProperties.username": string}>(...args)
+         * ```
+         * @param query.usqlFilter "WHERE" portion of a USQL call. Do not include the "WHERE" text.
+         * @param query.startTimestamp Unix start timestamp of window to pull USQL data. Defaults to 2 hours ago.
+         * @param query.endTimestamp   Unix end timestamp of window to pull USQL data. Defaults to now.
+         * @param requestArgs
+         *
+         */
+        getAllUserErrors: <T_3 = {}>(query: {
+            customMetrics?: string[];
+            usqlFilter?: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+        }, requestArgs?: any) => Promise<(UserSessionErrors & {
+            "usersession.userSessionId": string;
+        } & T_3)[]>;
+        getUsqlResults: (query: {
+            query: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+            offsetUTC?: number;
+            pageSize?: number;
+            pageOffset?: number;
+            addDeepLinkFields?: boolean;
+            explain?: boolean;
+        }, params?: import("../types/options").RequestOptions) => Promise<import("./generated/env-v1").UsqlResultAsTable>;
+        getUsqlResultsAsTree: (query: {
+            query: string;
+            startTimestamp?: number;
+            endTimestamp?: number;
+            offsetUTC?: number;
+            addDeepLinkFields?: boolean;
+            explain?: boolean;
+        }, params?: import("../types/options").RequestOptions) => Promise<import("./generated/env-v1").UsqlResultAsTree>;
+    };
+    /**
+     * use `usql` instead.
+     * @hidden
+     * @deprecated
+     * @invalid
+     */
     private fetchChunkedUSQLdata;
 }
+export {};

dist/api/env-v1.js

@@ -19,23 +19,5 @@ "use strict";
         super(connection, "api/v1", options);
-        this.usql = this.userSessionQueryLanguage;
         this.userSessionQueryLanguage = {
+            ...super.userSessionQueryLanguage,
             /**
-             * RUM - User sessions \
-             * `GET:/userSessionQueryLanguage/table` \
-             * Returns the result of the query as a table structure \
-             *
-             * ---
-             * @returns The result is a flat list of rows containing the requested columns.
-             */
-            getUsqlResults: this.usql.getUsqlResults,
-            /**
-             * RUM - User sessions \
-             * `GET:/userSessionQueryLanguage/tree` \
-             * Returns the result of the query as a tree structure \
-             *
-             * ---
-             * @returns To get a proper tree structure, you need to specify grouping in the query.
-             */
-            getUsqlResultsAsTree: this.usql.getUsqlResultsAsTree,
-            /**
              * A method to return all user sessions from a tenant in the specified timeframe.
@@ -130,2 +112,9 @@ * Caveats:
     }
+    /**
+     * use `usql` instead.
+     * @hidden
+     * @deprecated
+     * @invalid
+     */
+    // userSessionQueryLanguage: undefined;
     async fetchChunkedUSQLdata(query, requestArgs, table, metric) {
@@ -132,0 +121,0 @@ // I do not know why this is 1000.

dist/api/env-v2.js

@@ -24,3 +24,3 @@ "use strict";
             ...this.entities,
-            getEntitiesCount: async (query, params) => {
+            getEntitiesCount: async (query, params = {}) => {
                 query.pageSize = 1;
@@ -27,0 +27,0 @@ params.paging = false;

package.json

 {
   "name": "@dt-esa/dynatrace-api-client",
-  "version": "2.2.6",
+  "version": "2.2.7",
   "description": "",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

2241728

increased by0.31%

Lines of code

48004

increased by0.28%

No dependency changes