@sentry/api 0.356.0 → 0.357.0

package/dist/types.gen.d.ts

@@ -81,7 +81,12 @@ export type BaseDetectorTypeValidator = {
     workflow_ids?: Array<number>;
     /**
      *
-     * The data sources for the monitor to use based on what you want to measure.
+     * The data sources for the metric monitor to use based on what you want to measure.
+     *
+     * `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
+     * `"timeWindow": 300`.
      *
      * **Number of Errors Metric Monitor**
      * - `eventTypes`: Any of `error` or `default`.
@@ -94,9 +99,9 @@ export type BaseDetectorTypeValidator = {
      * "eventTypes": ["default", "error"],
      * "query": "is:unresolved",
      * "queryType": 0,
-     * "timeWindow": 3600,
-     * },
-     * ],
+     * "timeWindow": 3600
+     * }
+     * ]
      * ```
      *
      * **Users Experiencing Errors Metric Monitor**
@@ -110,9 +115,9 @@ export type BaseDetectorTypeValidator = {
      * "eventTypes": ["default", "error"],
      * "query": "is:unresolved",
      * "queryType": 0,
-     * "timeWindow": 3600,
-     * },
-     * ],
+     * "timeWindow": 3600
+     * }
+     * ]
      * ```
      *
      *
@@ -123,13 +128,13 @@ export type BaseDetectorTypeValidator = {
      * "aggregate":"count(span.duration)",
      * "dataset":"events_analytics_platform",
      * "environment":"prod",
-     * "eventTypes":["trace_item_span"]
+     * "eventTypes":["trace_item_span"],
      * "query":"",
      * "queryType":1,
      * "timeWindow":3600,
-     * "extrapolationMode":"unknown",
-     * },
-     * ],
+     * "extrapolationMode":"unknown"
+     * }
+     * ]
      * ```
      *
      * **Duration Metric Monitor**
@@ -139,13 +144,13 @@ export type BaseDetectorTypeValidator = {
      * "aggregate":"p95(span.duration)",
      * "dataset":"events_analytics_platform",
      * "environment":"prod",
-     * "eventTypes":["trace_item_span"]
+     * "eventTypes":["trace_item_span"],
      * "query":"",
      * "queryType":1,
      * "timeWindow":3600,
-     * "extrapolationMode":"unknown",
-     * },
-     * ],
+     * "extrapolationMode":"unknown"
+     * }
+     * ]
      * ```
      *
      * **Failure Rate Metric Monitor**
@@ -155,17 +160,17 @@ export type BaseDetectorTypeValidator = {
      * "aggregate":"failure_rate()",
      * "dataset":"events_analytics_platform",
      * "environment":"prod",
-     * "eventTypes":["trace_item_span"]
+     * "eventTypes":["trace_item_span"],
      * "query":"",
      * "queryType":1,
      * "timeWindow":3600,
-     * "extrapolationMode":"unknown",
-     * },
-     * ],
+     * "extrapolationMode":"unknown"
+     * }
+     * ]
      * ```
      *
      * **Largest Contentful Paint Metric Monitor**
-     * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+     * - `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.
      *
      * ```json
@@ -174,17 +179,17 @@ export type BaseDetectorTypeValidator = {
      * "aggregate":"p95(measurements.lcp)",
      * "dataset":"events_analytics_platform",
      * "environment":"prod",
-     * "eventTypes":["trace_item_span"]
-     * "query":"",
+     * "eventTypes":["trace_item_span"],
+     * "query":"is_transaction:true",
      * "queryType":1,
      * "timeWindow":3600,
-     * "extrapolationMode":"unknown",
-     * },
-     * ],
+     * "extrapolationMode":"unknown"
+     * }
+     * ]
      * ```
      *
      * **Custom Metric Monitor**
-     * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+     * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
      * - `aggregate`: Valid values are:
      * `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
      * `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
@@ -200,11 +205,17 @@ export type BaseDetectorTypeValidator = {
      * ```json
      * [
      * {
-     * "aggregate": "p75(measurements.ttfb)"
+     * "aggregate": "p75(measurements.ttfb)",
      * "dataset": "events_analytics_platform",
+     * "environment": "prod",
      * "queryType": 1,
-     * },
-     * ],
+     * "eventTypes": ["trace_item_span"],
+     * "query": "is_transaction:true",
+     * "timeWindow": 3600,
+     * "extrapolationMode": "unknown"
+     * }
+     * ]
+     * ```
      *
      */
     data_sources?: Array<unknown>;
@@ -217,7 +228,7 @@ export type BaseDetectorTypeValidator = {
      * - `static`: Threshold based monitor
      * - `percent`: Change based monitor
      * - `dynamic`: Dynamic monitor
-     * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.
+     * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period, in seconds, at which to compare against historical data.
      * For example, a value of 3600 compares the metric tracked against data 1 hour ago.
      * - `300`: 5 minutes
      * - `900`: 15 minutes
@@ -229,20 +240,20 @@ export type BaseDetectorTypeValidator = {
      * **Threshold**
      * ```json
      * {
-     * "detectionType": "static",
+     * "detectionType": "static"
      * }
      * ```
      * **Change**
      * ```json
      * {
      * "detectionType": "percent",
-     * "comparisonDelta": 3600,
+     * "comparisonDelta": 3600
      * }
      * ```
      * **Dynamic**
      * ```json
      * {
-     * "detectionType": "dynamic",
+     * "detectionType": "dynamic"
      * }
      * ```
      *
@@ -11393,7 +11404,7 @@ export type WorkflowValidator = {
      *
      * ```json
      * {
-     * "frequency":3600
+     * "frequency": 60
      * }
      * ```
      *
@@ -14536,7 +14547,12 @@ export type UpdateOrganizationDetectorData = {
         workflow_ids?: Array<number>;
         /**
          *
-         * The data sources for the monitor to use based on what you want to measure.
+         * The data sources for the metric monitor to use based on what you want to measure.
+         *
+         * `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
+         * `"timeWindow": 300`.
          *
          * **Number of Errors Metric Monitor**
          * - `eventTypes`: Any of `error` or `default`.
@@ -14549,9 +14565,9 @@ export type UpdateOrganizationDetectorData = {
          * "eventTypes": ["default", "error"],
          * "query": "is:unresolved",
          * "queryType": 0,
-         * "timeWindow": 3600,
-         * },
-         * ],
+         * "timeWindow": 3600
+         * }
+         * ]
          * ```
          *
          * **Users Experiencing Errors Metric Monitor**
@@ -14565,9 +14581,9 @@ export type UpdateOrganizationDetectorData = {
          * "eventTypes": ["default", "error"],
          * "query": "is:unresolved",
          * "queryType": 0,
-         * "timeWindow": 3600,
-         * },
-         * ],
+         * "timeWindow": 3600
+         * }
+         * ]
          * ```
          *
          *
@@ -14578,13 +14594,13 @@ export type UpdateOrganizationDetectorData = {
          * "aggregate":"count(span.duration)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Duration Metric Monitor**
@@ -14594,13 +14610,13 @@ export type UpdateOrganizationDetectorData = {
          * "aggregate":"p95(span.duration)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Failure Rate Metric Monitor**
@@ -14610,17 +14626,17 @@ export type UpdateOrganizationDetectorData = {
          * "aggregate":"failure_rate()",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Largest Contentful Paint Metric Monitor**
-         * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+         * - `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.
          *
          * ```json
@@ -14629,17 +14645,17 @@ export type UpdateOrganizationDetectorData = {
          * "aggregate":"p95(measurements.lcp)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
-         * "query":"",
+         * "eventTypes":["trace_item_span"],
+         * "query":"is_transaction:true",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Custom Metric Monitor**
-         * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+         * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
          * - `aggregate`: Valid values are:
          * `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
@@ -14655,11 +14671,17 @@ export type UpdateOrganizationDetectorData = {
          * ```json
          * [
          * {
-         * "aggregate": "p75(measurements.ttfb)"
+         * "aggregate": "p75(measurements.ttfb)",
          * "dataset": "events_analytics_platform",
+         * "environment": "prod",
          * "queryType": 1,
-         * },
-         * ],
+         * "eventTypes": ["trace_item_span"],
+         * "query": "is_transaction:true",
+         * "timeWindow": 3600,
+         * "extrapolationMode": "unknown"
+         * }
+         * ]
+         * ```
          *
          */
         data_sources?: Array<unknown>;
@@ -14672,7 +14694,7 @@ export type UpdateOrganizationDetectorData = {
          * - `static`: Threshold based monitor
          * - `percent`: Change based monitor
          * - `dynamic`: Dynamic monitor
-         * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.
+         * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period, in seconds, at which to compare against historical data.
          * For example, a value of 3600 compares the metric tracked against data 1 hour ago.
          * - `300`: 5 minutes
          * - `900`: 15 minutes
@@ -14684,20 +14706,20 @@ export type UpdateOrganizationDetectorData = {
          * **Threshold**
          * ```json
          * {
-         * "detectionType": "static",
+         * "detectionType": "static"
          * }
          * ```
          * **Change**
          * ```json
          * {
          * "detectionType": "percent",
-         * "comparisonDelta": 3600,
+         * "comparisonDelta": 3600
          * }
          * ```
          * **Dynamic**
          * ```json
          * {
-         * "detectionType": "dynamic",
+         * "detectionType": "dynamic"
          * }
          * ```
          *
@@ -21930,7 +21952,12 @@ export type CreateOrganizationProjectDetectorData = {
         workflow_ids?: Array<number>;
         /**
          *
-         * The data sources for the monitor to use based on what you want to measure.
+         * The data sources for the metric monitor to use based on what you want to measure.
+         *
+         * `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
+         * `"timeWindow": 300`.
          *
          * **Number of Errors Metric Monitor**
          * - `eventTypes`: Any of `error` or `default`.
@@ -21943,9 +21970,9 @@ export type CreateOrganizationProjectDetectorData = {
          * "eventTypes": ["default", "error"],
          * "query": "is:unresolved",
          * "queryType": 0,
-         * "timeWindow": 3600,
-         * },
-         * ],
+         * "timeWindow": 3600
+         * }
+         * ]
          * ```
          *
          * **Users Experiencing Errors Metric Monitor**
@@ -21959,9 +21986,9 @@ export type CreateOrganizationProjectDetectorData = {
          * "eventTypes": ["default", "error"],
          * "query": "is:unresolved",
          * "queryType": 0,
-         * "timeWindow": 3600,
-         * },
-         * ],
+         * "timeWindow": 3600
+         * }
+         * ]
          * ```
          *
          *
@@ -21972,13 +21999,13 @@ export type CreateOrganizationProjectDetectorData = {
          * "aggregate":"count(span.duration)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Duration Metric Monitor**
@@ -21988,13 +22015,13 @@ export type CreateOrganizationProjectDetectorData = {
          * "aggregate":"p95(span.duration)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Failure Rate Metric Monitor**
@@ -22004,17 +22031,17 @@ export type CreateOrganizationProjectDetectorData = {
          * "aggregate":"failure_rate()",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
+         * "eventTypes":["trace_item_span"],
          * "query":"",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Largest Contentful Paint Metric Monitor**
-         * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+         * - `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.
          *
          * ```json
@@ -22023,17 +22050,17 @@ export type CreateOrganizationProjectDetectorData = {
          * "aggregate":"p95(measurements.lcp)",
          * "dataset":"events_analytics_platform",
          * "environment":"prod",
-         * "eventTypes":["trace_item_span"]
-         * "query":"",
+         * "eventTypes":["trace_item_span"],
+         * "query":"is_transaction:true",
          * "queryType":1,
          * "timeWindow":3600,
-         * "extrapolationMode":"unknown",
-         * },
-         * ],
+         * "extrapolationMode":"unknown"
+         * }
+         * ]
          * ```
          *
          * **Custom Metric Monitor**
-         * - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.
+         * - `dataset`: Use `events_analytics_platform`. To query transaction spans, add `is_transaction:true` to `query`.
          * - `aggregate`: Valid values are:
          * `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
          * `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.
@@ -22049,11 +22076,17 @@ export type CreateOrganizationProjectDetectorData = {
          * ```json
          * [
          * {
-         * "aggregate": "p75(measurements.ttfb)"
+         * "aggregate": "p75(measurements.ttfb)",
          * "dataset": "events_analytics_platform",
+         * "environment": "prod",
          * "queryType": 1,
-         * },
-         * ],
+         * "eventTypes": ["trace_item_span"],
+         * "query": "is_transaction:true",
+         * "timeWindow": 3600,
+         * "extrapolationMode": "unknown"
+         * }
+         * ]
+         * ```
          *
          */
         data_sources?: Array<unknown>;
@@ -22066,7 +22099,7 @@ export type CreateOrganizationProjectDetectorData = {
          * - `static`: Threshold based monitor
          * - `percent`: Change based monitor
          * - `dynamic`: Dynamic monitor
-         * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.
+         * - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period, in seconds, at which to compare against historical data.
          * For example, a value of 3600 compares the metric tracked against data 1 hour ago.
          * - `300`: 5 minutes
          * - `900`: 15 minutes
@@ -22078,20 +22111,20 @@ export type CreateOrganizationProjectDetectorData = {
          * **Threshold**
          * ```json
          * {
-         * "detectionType": "static",
+         * "detectionType": "static"
          * }
          * ```
          * **Change**
          * ```json
          * {
          * "detectionType": "percent",
-         * "comparisonDelta": 3600,
+         * "comparisonDelta": 3600
          * }
          * ```
          * **Dynamic**
          * ```json
          * {
-         * "detectionType": "dynamic",
+         * "detectionType": "dynamic"
          * }
          * ```
          *
@@ -27384,7 +27417,7 @@ export type CreateOrganizationWorkflowData = {
          *
          * ```json
          * {
-         * "frequency":3600
+         * "frequency": 60
          * }
          * ```
          *
@@ -28412,7 +28445,7 @@ export type UpdateOrganizationWorkflowData = {
          *
          * ```json
          * {
-         * "frequency":3600
+         * "frequency": 60
          * }
          * ```
          *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/api",
-  "version": "0.356.0",
+  "version": "0.357.0",
   "description": "Official auto-generated TypeScript client for the Sentry public REST API",
   "keywords": [
     "sentry",