New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@dt-esa/dynatrace-api-client
Advanced tools
@dt-esa/dynatrace-api-client - npm Package Compare versions
Comparing version 2.2.5 to 2.2.6
| import { DynatraceConnection } from "../types/dynatrace-connection"; | ||
| import { APIOptions } from "../types/options"; | ||
| 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; | ||
| }; | ||
| import { internalEnvV1 as EnvironmentV1 } from "./generated/env-v1"; | ||
| /** | ||
@@ -26,150 +17,5 @@ * @title Dynatrace Environment API | ||
| constructor(connection: DynatraceConnection, options?: APIOptions); | ||
| 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: (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>; | ||
| /** | ||
| * 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: (query: { | ||
| query: string; | ||
| startTimestamp?: number; | ||
| endTimestamp?: number; | ||
| offsetUTC?: number; | ||
| addDeepLinkFields?: boolean; | ||
| explain?: boolean; | ||
| }, params?: import("../types/options").RequestOptions) => Promise<import("./generated/env-v1").UsqlResultAsTree>; | ||
| /** | ||
| * 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)[]>; | ||
| }; | ||
| private readonly usql; | ||
| userSessionQueryLanguage: any; | ||
| private fetchChunkedUSQLdata; | ||
| } | ||
| export {}; |
@@ -19,2 +19,3 @@ "use strict"; | ||
| super(connection, "api/v1", options); | ||
| this.usql = this.userSessionQueryLanguage; | ||
| this.userSessionQueryLanguage = { | ||
@@ -29,3 +30,3 @@ /** | ||
| */ | ||
| getUsqlResults: super.userSessionQueryLanguage.getUsqlResults, | ||
| getUsqlResults: this.usql.getUsqlResults, | ||
| /** | ||
@@ -39,3 +40,3 @@ * RUM - User sessions \ | ||
| */ | ||
| getUsqlResultsAsTree: super.userSessionQueryLanguage.getUsqlResultsAsTree, | ||
| getUsqlResultsAsTree: this.usql.getUsqlResultsAsTree, | ||
| /** | ||
@@ -42,0 +43,0 @@ * A method to return all user sessions from a tenant in the specified timeframe. |
| { | ||
| "name": "@dt-esa/dynatrace-api-client", | ||
| "version": "2.2.5", | ||
| "version": "2.2.6", | ||
| "description": "", | ||
@@ -5,0 +5,0 @@ "main": "./dist/index.js", |
Sorry, the diff of this file is not supported yet
No alert changes
Worsened metrics
- Total package byte prevSize
- decreased by-0.37%
2234698
- Lines of code
- decreased by-0.32%
47871
No dependency changes