@sentry/api 0.435.0 → 0.436.0

package/dist/types.gen.d.ts

@@ -113,6 +113,9 @@ export type BaseDetectorTypeValidator = {
      *
      * The data sources for the metric monitor to use based on what you want to measure.
      *
+     * The schema of each data source lists the `aggregate` values that its `dataset` and
+     * `eventTypes` accept.
+     *
      * `timeWindow` is measured in seconds. Cron Monitors use schedules instead of this field.
      * Legacy metric alert rules expressed this value in minutes, so multiply a legacy value
      * by 60 when migrating it to a monitor. For example, a legacy 5-minute window becomes
@@ -201,7 +204,7 @@ export type BaseDetectorTypeValidator = {
      *
      * **Largest Contentful Paint Metric Monitor**
      * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
-     * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.
+     * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, and `p100(measurements.lcp)`.
      *
      * ```json
      * [
@@ -227,7 +230,6 @@ export type BaseDetectorTypeValidator = {
      * `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
      * `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
      * `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
-     * `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.
      * `failure_rate()`
      * `apdex(x)`, where `x` is the value of the Apdex score.
      * `count()`
@@ -248,7 +250,91 @@ export type BaseDetectorTypeValidator = {
      * ```
      *
      */
-    data_sources?: Array<unknown>;
+    data_sources?: Array<{
+        query_type?: 0;
+        dataset: 'events';
+        /**
+         * A search query to filter the events, such as `is:unresolved`.
+         */
+        query: string;
+        aggregate: 'count()' | 'count_unique(user)' | 'count_unique(dist)' | 'count_unique(release)' | 'count_unique(tags[sentry:user])' | 'count_unique(tags[sentry:dist])' | 'count_unique(tags[sentry:release])';
+        /**
+         * The time window to aggregate over, in seconds.
+         */
+        time_window: number;
+        environment: string | null;
+        event_types: Array<'error' | 'default'>;
+        extrapolation_mode?: string | null;
+    } | {
+        query_type?: 1;
+        dataset: 'events_analytics_platform';
+        /**
+         * A search query to filter the events, such as `is:unresolved`.
+         */
+        query: string;
+        aggregate: string;
+        /**
+         * The time window to aggregate over, in seconds.
+         */
+        time_window: number;
+        environment: string | null;
+        event_types: [
+            'trace_item_span'
+        ];
+        extrapolation_mode?: string | null;
+    } | {
+        query_type?: 1;
+        dataset: 'events_analytics_platform';
+        /**
+         * A search query to filter the events, such as `is:unresolved`.
+         */
+        query: string;
+        aggregate: string;
+        /**
+         * The time window to aggregate over, in seconds.
+         */
+        time_window: number;
+        environment: string | null;
+        event_types: [
+            'trace_item_log'
+        ];
+        extrapolation_mode?: string | null;
+    } | {
+        query_type?: 1;
+        dataset: 'events_analytics_platform';
+        /**
+         * A search query to filter the events, such as `is:unresolved`.
+         */
+        query: string;
+        aggregate: string;
+        /**
+         * The time window to aggregate over, in seconds.
+         */
+        time_window: number;
+        environment: string | null;
+        event_types: [
+            'trace_item_metric'
+        ];
+        extrapolation_mode?: string | null;
+    } | {
+        query_type?: 2;
+        dataset: 'metrics';
+        /**
+         * A search query to filter the events, such as `is:unresolved`.
+         */
+        query: string;
+        aggregate: string;
+        /**
+         * The time window to aggregate over, in seconds.
+         */
+        time_window: number;
+        environment: string | null;
+        /**
+         * Ignored for this dataset. Send an empty list.
+         */
+        event_types: Array<string>;
+        extrapolation_mode?: string | null;
+    }>;
     /**
      *
      * The issue detection type configuration.
@@ -15849,6 +15935,9 @@ export type UpdateOrganizationDetectorData = {
          *
          * The data sources for the metric monitor to use based on what you want to measure.
          *
+         * The schema of each data source lists the `aggregate` values that its `dataset` and
+         * `eventTypes` accept.
+         *
          * `timeWindow` is measured in seconds. Cron Monitors use schedules instead of this field.
          * Legacy metric alert rules expressed this value in minutes, so multiply a legacy value
          * by 60 when migrating it to a monitor. For example, a legacy 5-minute window becomes
@@ -15937,7 +16026,7 @@ export type UpdateOrganizationDetectorData = {
          *
          * **Largest Contentful Paint Metric Monitor**
          * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
-         * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.
+         * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, and `p100(measurements.lcp)`.
          *
          * ```json
          * [
@@ -15963,7 +16052,6 @@ export type UpdateOrganizationDetectorData = {
          * `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
-         * `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.
          * `failure_rate()`
          * `apdex(x)`, where `x` is the value of the Apdex score.
          * `count()`
@@ -15984,7 +16072,91 @@ export type UpdateOrganizationDetectorData = {
          * ```
          *
          */
-        data_sources?: Array<unknown>;
+        data_sources?: Array<{
+            query_type?: 0;
+            dataset: 'events';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: 'count()' | 'count_unique(user)' | 'count_unique(dist)' | 'count_unique(release)' | 'count_unique(tags[sentry:user])' | 'count_unique(tags[sentry:dist])' | 'count_unique(tags[sentry:release])';
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: Array<'error' | 'default'>;
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_span'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_log'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_metric'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 2;
+            dataset: 'metrics';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            /**
+             * Ignored for this dataset. Send an empty list.
+             */
+            event_types: Array<string>;
+            extrapolation_mode?: string | null;
+        }>;
         /**
          *
          * The issue detection type configuration.
@@ -23283,6 +23455,9 @@ export type CreateOrganizationProjectDetectorData = {
          *
          * The data sources for the metric monitor to use based on what you want to measure.
          *
+         * The schema of each data source lists the `aggregate` values that its `dataset` and
+         * `eventTypes` accept.
+         *
          * `timeWindow` is measured in seconds. Cron Monitors use schedules instead of this field.
          * Legacy metric alert rules expressed this value in minutes, so multiply a legacy value
          * by 60 when migrating it to a monitor. For example, a legacy 5-minute window becomes
@@ -23371,7 +23546,7 @@ export type CreateOrganizationProjectDetectorData = {
          *
          * **Largest Contentful Paint Metric Monitor**
          * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
-         * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.
+         * - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, and `p100(measurements.lcp)`.
          *
          * ```json
          * [
@@ -23397,7 +23572,6 @@ export type CreateOrganizationProjectDetectorData = {
          * `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
-         * `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.
          * `failure_rate()`
          * `apdex(x)`, where `x` is the value of the Apdex score.
          * `count()`
@@ -23418,7 +23592,91 @@ export type CreateOrganizationProjectDetectorData = {
          * ```
          *
          */
-        data_sources?: Array<unknown>;
+        data_sources?: Array<{
+            query_type?: 0;
+            dataset: 'events';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: 'count()' | 'count_unique(user)' | 'count_unique(dist)' | 'count_unique(release)' | 'count_unique(tags[sentry:user])' | 'count_unique(tags[sentry:dist])' | 'count_unique(tags[sentry:release])';
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: Array<'error' | 'default'>;
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_span'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_log'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 1;
+            dataset: 'events_analytics_platform';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            event_types: [
+                'trace_item_metric'
+            ];
+            extrapolation_mode?: string | null;
+        } | {
+            query_type?: 2;
+            dataset: 'metrics';
+            /**
+             * A search query to filter the events, such as `is:unresolved`.
+             */
+            query: string;
+            aggregate: string;
+            /**
+             * The time window to aggregate over, in seconds.
+             */
+            time_window: number;
+            environment: string | null;
+            /**
+             * Ignored for this dataset. Send an empty list.
+             */
+            event_types: Array<string>;
+            extrapolation_mode?: string | null;
+        }>;
         /**
          *
          * The issue detection type configuration.