@sentry/api 0.213.0 → 0.214.0

package/dist/sdk.gen.d.ts

@@ -142,6 +142,11 @@ export declare const listOrganizationEvents: <ThrowOnError extends boolean = fal
  *
  * This endpoint can return timeseries for either 1 or many axis, and results grouped to the top events depending
  * on the parameters passed
+ *
+ * **Note**: For queries extending past `30d`, spanning billions of rows, or running on projects with low
+ * sample rates, the aggregation `yAxis=count_unique()` and filters on high-cardinality
+ * fields (such as `query=user.id:bc`) will not return accurate results. Use these queries for rough
+ * estimation only.
  */
 export declare const listOrganizationEventsTimeseries: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationEventsTimeseriesData, ThrowOnError>) => import("./client").RequestResult<ListOrganizationEventsTimeseriesResponses, ListOrganizationEventsTimeseriesErrors, ThrowOnError, "fields">;
 /**

package/dist/types.gen.d.ts

@@ -13033,7 +13033,22 @@ export type ListOrganizationEventsTimeseriesData = {
          */
         groupBy?: Array<string>;
         /**
-         * The aggregate field to create the timeseries for, defaults to `count()` when not included
+         * The aggregate field to create the timeseries for, defaults to `count()` when
+         * not included.
+         * - `count()` - Total count of events over the period.
+         * - `avg(field)` - Average value of the field over the period.
+         * - `pXX(field)` - Percentile value of the field over the period. One of: `p50`, `p75`, `p90`, `p95`, `p99`, `p100`.
+         * - `sum(field)` - Sum of all values for the field over the period.
+         * - `min(field)` - Lowest value observed for the field over the period.
+         * - `max(field)` - Highest value observed for the field over the period.
+         * - `count_unique(field)` - Count of unique values observed for the field over the period. See *Note:* regarding accuracy on sampled data.
+         * - `epm` - Average number of events received per minute.
+         * - `eps` - Average number of events received per second.
+         * - `failure_rate()` - Percentage of events whose `status` indicates failure.
+         * - `failure_count()` - Total count of events with an error `status` over period.
+         * - `performance_score(field)` - Web Vitals performance score for the selected measurement.
+         * - `opportunity_score(field)` - Web Vitals opportunity score for the selected measurement.
+         *
          */
         yAxis?: string;
         /**

package/package.json

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