@sentry/api 0.213.0 → 0.215.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/sdk.gen.d.ts CHANGED
@@ -142,6 +142,11 @@ export declare const listOrganizationEvents: <ThrowOnError extends boolean = fal
142
142
  *
143
143
  * This endpoint can return timeseries for either 1 or many axis, and results grouped to the top events depending
144
144
  * on the parameters passed
145
+ *
146
+ * **Note**: For queries extending past `30d`, spanning billions of rows, or running on projects with low
147
+ * sample rates, the aggregation `yAxis=count_unique()` and filters on high-cardinality
148
+ * fields (such as `query=user.id:bc`) will not return accurate results. Use these queries for rough
149
+ * estimation only.
145
150
  */
146
151
  export declare const listOrganizationEventsTimeseries: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationEventsTimeseriesData, ThrowOnError>) => import("./client").RequestResult<ListOrganizationEventsTimeseriesResponses, ListOrganizationEventsTimeseriesErrors, ThrowOnError, "fields">;
147
152
  /**
@@ -4849,7 +4849,7 @@ export type MonitorList = Array<{
4849
4849
  */
4850
4850
  export type MonitorValidator = {
4851
4851
  /**
4852
- * The project slug to associate the monitor to.
4852
+ * The project ID or slug to associate the monitor to.
4853
4853
  */
4854
4854
  project: string;
4855
4855
  /**
@@ -5553,7 +5553,7 @@ export type NotificationAction = {
5553
5553
  */
5554
5554
  target_display?: string;
5555
5555
  /**
5556
- * List of projects slugs that the Notification Action is created for.
5556
+ * List of project IDs or slugs that the Notification Action is created for.
5557
5557
  */
5558
5558
  projects?: Array<string>;
5559
5559
  };
@@ -13033,7 +13033,22 @@ export type ListOrganizationEventsTimeseriesData = {
13033
13033
  */
13034
13034
  groupBy?: Array<string>;
13035
13035
  /**
13036
- * The aggregate field to create the timeseries for, defaults to `count()` when not included
13036
+ * The aggregate field to create the timeseries for, defaults to `count()` when
13037
+ * not included.
13038
+ * - `count()` - Total count of events over the period.
13039
+ * - `avg(field)` - Average value of the field over the period.
13040
+ * - `pXX(field)` - Percentile value of the field over the period. One of: `p50`, `p75`, `p90`, `p95`, `p99`, `p100`.
13041
+ * - `sum(field)` - Sum of all values for the field over the period.
13042
+ * - `min(field)` - Lowest value observed for the field over the period.
13043
+ * - `max(field)` - Highest value observed for the field over the period.
13044
+ * - `count_unique(field)` - Count of unique values observed for the field over the period. See *Note:* regarding accuracy on sampled data.
13045
+ * - `epm` - Average number of events received per minute.
13046
+ * - `eps` - Average number of events received per second.
13047
+ * - `failure_rate()` - Percentage of events whose `status` indicates failure.
13048
+ * - `failure_count()` - Total count of events with an error `status` over period.
13049
+ * - `performance_score(field)` - Web Vitals performance score for the selected measurement.
13050
+ * - `opportunity_score(field)` - Web Vitals opportunity score for the selected measurement.
13051
+ *
13037
13052
  */
13038
13053
  yAxis?: string;
13039
13054
  /**
@@ -15156,7 +15171,7 @@ export type CreateOrganizationMonitorData = {
15156
15171
  */
15157
15172
  body: {
15158
15173
  /**
15159
- * The project slug to associate the monitor to.
15174
+ * The project ID or slug to associate the monitor to.
15160
15175
  */
15161
15176
  project: string;
15162
15177
  /**
@@ -16123,7 +16138,7 @@ export type UpdateOrganizationMonitorData = {
16123
16138
  */
16124
16139
  body: {
16125
16140
  /**
16126
- * The project slug to associate the monitor to.
16141
+ * The project ID or slug to associate the monitor to.
16127
16142
  */
16128
16143
  project: string;
16129
16144
  /**
@@ -17074,7 +17089,7 @@ export type CreateOrganizationNotificationsActionData = {
17074
17089
  */
17075
17090
  target_display?: string;
17076
17091
  /**
17077
- * List of projects slugs that the Notification Action is created for.
17092
+ * List of project IDs or slugs that the Notification Action is created for.
17078
17093
  */
17079
17094
  projects?: Array<string>;
17080
17095
  };
@@ -17207,7 +17222,7 @@ export type UpdateOrganizationNotificationsActionData = {
17207
17222
  */
17208
17223
  target_display?: string;
17209
17224
  /**
17210
- * List of projects slugs that the Notification Action is created for.
17225
+ * List of project IDs or slugs that the Notification Action is created for.
17211
17226
  */
17212
17227
  projects?: Array<string>;
17213
17228
  };
@@ -17733,9 +17748,9 @@ export type ListOrganizationPreprodartifactsSnapshotsLatestBaseData = {
17733
17748
  */
17734
17749
  branch?: string;
17735
17750
  /**
17736
- * Project ID to scope the lookup.
17751
+ * Project ID or slug to scope the lookup.
17737
17752
  */
17738
- project?: number;
17753
+ project?: number | string;
17739
17754
  /**
17740
17755
  * Set to '1' or 'true' to strip image metadata to display_name, image_file_name, group, description, and image_url only.
17741
17756
  */
@@ -25969,7 +25984,7 @@ export type UpdateProjectMonitorData = {
25969
25984
  */
25970
25985
  body: {
25971
25986
  /**
25972
- * The project slug to associate the monitor to.
25987
+ * The project ID or slug to associate the monitor to.
25973
25988
  */
25974
25989
  project: string;
25975
25990
  /**
package/dist/zod.gen.d.ts CHANGED
@@ -44031,23 +44031,23 @@ export declare const zListOrganizationPreprodartifactsSnapshotsLatestBaseData: z
44031
44031
  query: z.ZodObject<{
44032
44032
  app_id: z.ZodString;
44033
44033
  branch: z.ZodOptional<z.ZodString>;
44034
- project: z.ZodOptional<z.ZodNumber>;
44034
+ project: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
44035
44035
  compact_metadata: z.ZodOptional<z.ZodString>;
44036
44036
  }, "strip", z.ZodTypeAny, {
44037
44037
  app_id: string;
44038
- project?: number | undefined;
44038
+ project?: string | number | undefined;
44039
44039
  compact_metadata?: string | undefined;
44040
44040
  branch?: string | undefined;
44041
44041
  }, {
44042
44042
  app_id: string;
44043
- project?: number | undefined;
44043
+ project?: string | number | undefined;
44044
44044
  compact_metadata?: string | undefined;
44045
44045
  branch?: string | undefined;
44046
44046
  }>;
44047
44047
  }, "strip", z.ZodTypeAny, {
44048
44048
  query: {
44049
44049
  app_id: string;
44050
- project?: number | undefined;
44050
+ project?: string | number | undefined;
44051
44051
  compact_metadata?: string | undefined;
44052
44052
  branch?: string | undefined;
44053
44053
  };
@@ -44058,7 +44058,7 @@ export declare const zListOrganizationPreprodartifactsSnapshotsLatestBaseData: z
44058
44058
  }, {
44059
44059
  query: {
44060
44060
  app_id: string;
44061
- project?: number | undefined;
44061
+ project?: string | number | undefined;
44062
44062
  compact_metadata?: string | undefined;
44063
44063
  branch?: string | undefined;
44064
44064
  };
package/dist/zod.js CHANGED
@@ -17169,7 +17169,10 @@ var zListOrganizationPreprodartifactsSnapshotsLatestBaseData = z.object({
17169
17169
  query: z.object({
17170
17170
  app_id: z.string(),
17171
17171
  branch: z.string().optional(),
17172
- project: z.number().int().optional(),
17172
+ project: z.union([
17173
+ z.number().int(),
17174
+ z.string()
17175
+ ]).optional(),
17173
17176
  compact_metadata: z.string().optional()
17174
17177
  })
17175
17178
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sentry/api",
3
- "version": "0.213.0",
3
+ "version": "0.215.0",
4
4
  "description": "Official auto-generated TypeScript client for the Sentry public REST API",
5
5
  "keywords": [
6
6
  "sentry",