@roarkanalytics/sdk 5.7.0 → 5.9.0

package/resources/analytics.d.ts

@@ -0,0 +1,354 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Analytics extends APIResource {
+    /**
+     * Lists what can go into an analytics query for this project: every metric by slug
+     * with its output type, default aggregation and the aggregations it supports; the
+     * measure types; the filter and breakdown types with the properties each accepts;
+     * and the custom call properties seen in the project. Read this first when
+     * building a query.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.getSchema();
+     * ```
+     */
+    getSchema(options?: RequestOptions): APIPromise<AnalyticsGetSchemaResponse>;
+    /**
+     * Aggregates metric values and conversation counts over a time window and returns
+     * one series per measure, with a total for the window and per-interval buckets.
+     * The same query a dashboard widget runs, without saving anything.
+     *
+     * - `measures`: what to aggregate. A METRIC measure names its metric by slug;
+     *   CONVERSATION counts conversations; UPTIME reads health checks. The aggregation
+     *   defaults by the metric's output type.
+     * - `timeRange`: LAST n DAYS/WEEKS/MONTHS, a CALENDAR_ALIGNED period (TODAY,
+     *   THIS_MONTH, ...), FIXED from/to, or SINCE. Defaults to the last 30 days; at
+     *   most 731 days. Calendar periods and buckets align to `timezone` (IANA, default
+     *   UTC).
+     * - `filters` apply to every measure; a measure's own `filters` add to them.
+     * - `breakdown` on a measure returns one series per value (largest 50 kept).
+     * - `comparisonGroups` (2 to 5) run every measure once per named filter set;
+     *   `comparisonMode: PREVIOUS_PERIOD` adds the preceding window's values.
+     *
+     * Values are in the metric's display units. A PASS_RATE is a 0 to 1 share;
+     * `sampleSize` 0 means no data. A query the analytics store cannot answer returns
+     * 400 naming the unsupported part.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.query({
+     *   measures: [{}],
+     * });
+     * ```
+     */
+    query(body: AnalyticsQueryParams, options?: RequestOptions): APIPromise<AnalyticsQueryResponse>;
+}
+export interface AnalyticsGetSchemaResponse {
+    /**
+     * What can be queried in this project: metrics (by slug), measure types, filters,
+     * breakdowns.
+     */
+    data: AnalyticsGetSchemaResponse.Data;
+}
+export declare namespace AnalyticsGetSchemaResponse {
+    /**
+     * What can be queried in this project: metrics (by slug), measure types, filters,
+     * breakdowns.
+     */
+    interface Data {
+        breakdowns: Array<Data.Breakdown>;
+        callProperties: Array<Data.CallProperty>;
+        displayTypes: Array<'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE'>;
+        filters: Array<Data.Filter>;
+        intervals: Array<'HOUR' | 'DAY' | 'WEEK' | 'MONTH'>;
+        measureTypes: Array<Data.MeasureType>;
+        metrics: Array<Data.Metric>;
+        operators: Array<'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH'>;
+    }
+    namespace Data {
+        interface Breakdown {
+            description: string;
+            type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
+        }
+        interface CallProperty {
+            isSystem: boolean;
+            name: string;
+            valueType: string;
+        }
+        interface Filter {
+            description: string;
+            properties: Array<Filter.Property>;
+            type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET' | 'METRIC_VALUE';
+        }
+        namespace Filter {
+            interface Property {
+                description: string;
+                property: string;
+            }
+        }
+        interface MeasureType {
+            aggregations: Array<'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE'>;
+            description: string;
+            type: 'METRIC' | 'CONVERSATION' | 'UPTIME';
+        }
+        interface Metric {
+            id: string;
+            aggregations: Array<'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE'>;
+            defaultAggregation: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
+            isThreshold: boolean;
+            name: string;
+            outputType: string;
+            slug: string;
+        }
+    }
+}
+export interface AnalyticsQueryResponse {
+    /**
+     * One series per measure (or per breakdown value / comparison group). `value` is
+     * the aggregate over the whole window; `buckets` hold the per-interval values.
+     */
+    data: AnalyticsQueryResponse.Data;
+}
+export declare namespace AnalyticsQueryResponse {
+    /**
+     * One series per measure (or per breakdown value / comparison group). `value` is
+     * the aggregate over the whole window; `buckets` hold the per-interval values.
+     */
+    interface Data {
+        from: string;
+        interval: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
+        omittedSeries: number;
+        series: Array<Data.Sery>;
+        timezone: string;
+        to: string;
+    }
+    namespace Data {
+        interface Sery {
+            aggregation: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
+            breakdownValue: string | null;
+            buckets: Array<Sery.Bucket>;
+            comparisonGroup: string | null;
+            comparisonValue: number | null;
+            measureIndex: number;
+            metric: string | null;
+            percentageOfBaseline: number | null;
+            sampleSize: number | null;
+            type: 'METRIC' | 'CONVERSATION' | 'UPTIME';
+            value: number;
+        }
+        namespace Sery {
+            interface Bucket {
+                date: string;
+                value: number;
+                comparisonDate?: string;
+                comparisonValue?: number;
+                passed?: number;
+                percentageOfBaseline?: number;
+                sampleSize?: number;
+            }
+        }
+    }
+}
+export interface AnalyticsQueryParams {
+    /**
+     * What to aggregate: 1 to 10 measures.
+     */
+    measures: Array<AnalyticsQueryParams.Measure>;
+    /**
+     * Run every measure once per named filter set, e.g. one group per agent.
+     */
+    comparisonGroups?: Array<AnalyticsQueryParams.ComparisonGroup>;
+    /**
+     * PREVIOUS_PERIOD adds the preceding window of the same length to every series.
+     */
+    comparisonMode?: 'NONE' | 'PREVIOUS_PERIOD';
+    /**
+     * Applied to every measure, on top of each measure's own filters.
+     */
+    filters?: Array<AnalyticsQueryParams.Filter>;
+    /**
+     * Set false to return only the window totals.
+     */
+    includeBuckets?: boolean;
+    /**
+     * Bucket size. Defaults from the window's length and steps coarser when the window
+     * would exceed 500 buckets.
+     */
+    interval?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
+    /**
+     * Defaults to the last 30 days.
+     */
+    timeRange?: AnalyticsQueryParams.UnionMember0 | AnalyticsQueryParams.UnionMember1 | AnalyticsQueryParams.UnionMember2 | AnalyticsQueryParams.UnionMember3;
+    /**
+     * IANA zone that buckets and calendar periods align to, e.g. America/New_York.
+     * Defaults to UTC.
+     */
+    timezone?: string;
+}
+export declare namespace AnalyticsQueryParams {
+    interface Measure {
+        /**
+         * Defaults by output type: AVG for numeric metrics, COUNT (split by value) for
+         * classification and text, PASS_RATE for thresholds and uptime, COUNT for
+         * conversations.
+         */
+        aggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
+        /**
+         * Split the measure into one series per value of this dimension (the largest 50
+         * are returned). Ignored while comparisonGroups are set: each group is then one
+         * series.
+         */
+        breakdown?: Measure.Breakdown;
+        /**
+         * Chart color on a dashboard.
+         */
+        color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
+        /**
+         * CALL (default for metrics) folds each conversation to one value first, so a long
+         * call does not outweigh a short one. NONE aggregates every value.
+         */
+        distinctBy?: 'NONE' | 'CALL';
+        /**
+         * Filters for this measure only, on top of the query's filters.
+         */
+        filters?: Array<Measure.Filter>;
+        /**
+         * Mark one measure as the baseline: every series also reports its value as a
+         * percentage of it.
+         */
+        isBaseline?: boolean;
+        /**
+         * The metric's slug (e.g. `task_completion`) or id. Required for METRIC.
+         */
+        metric?: string;
+        /**
+         * How each conversation is folded when distinctBy is CALL. Defaults to SUM under
+         * SUM, else AVG.
+         */
+        nestedAggregation?: 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE';
+        nestedAggregationPercentile?: number;
+        /**
+         * PASS_RATE condition operator. Omit for a threshold metric: its own condition is
+         * used.
+         */
+        passOperator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
+        /**
+         * PASS_RATE condition value, e.g. 4 or "resolved".
+         */
+        passValue?: string | number | boolean;
+        /**
+         * Required with PERCENTILE, e.g. 95.
+         */
+        percentile?: number;
+        /**
+         * METRIC (default): a metric's values. CONVERSATION: conversation counts. UPTIME:
+         * health-check outcomes.
+         */
+        type?: 'METRIC' | 'CONVERSATION' | 'UPTIME';
+    }
+    namespace Measure {
+        /**
+         * Split the measure into one series per value of this dimension (the largest 50
+         * are returned). Ignored while comparisonGroups are set: each group is then one
+         * series.
+         */
+        interface Breakdown {
+            type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET';
+            /**
+             * The property to split by. Required for CALL_PROPERTY and METRIC_PROPERTY.
+             */
+            property?: string;
+        }
+        interface Filter {
+            /**
+             * What the filter narrows on. GET /v1/analytics/schema lists each type.
+             */
+            type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET' | 'METRIC_VALUE';
+            /**
+             * The value to compare against (an agent id, "call" / "chat", a property value).
+             */
+            value: string | number | boolean;
+            /**
+             * Defaults to EQUALS.
+             */
+            operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
+            /**
+             * The property to compare. Required for CALL_PROPERTY and METRIC_PROPERTY; may be
+             * omitted for AGENT_PROPERTY, DATASET, MODALITY and CALL_ID.
+             */
+            property?: string;
+        }
+    }
+    interface ComparisonGroup {
+        filters: Array<ComparisonGroup.Filter>;
+        /**
+         * The series label; unique within the query.
+         */
+        name: string;
+        color?: 'GREEN' | 'RED' | 'ORANGE' | 'PURPLE' | 'GREY' | 'BLUE' | 'PEACH' | 'TEAL' | 'INDIGO' | 'AMBER' | 'ROSE' | 'CYAN';
+    }
+    namespace ComparisonGroup {
+        interface Filter {
+            /**
+             * What the filter narrows on. GET /v1/analytics/schema lists each type.
+             */
+            type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET' | 'METRIC_VALUE';
+            /**
+             * The value to compare against (an agent id, "call" / "chat", a property value).
+             */
+            value: string | number | boolean;
+            /**
+             * Defaults to EQUALS.
+             */
+            operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
+            /**
+             * The property to compare. Required for CALL_PROPERTY and METRIC_PROPERTY; may be
+             * omitted for AGENT_PROPERTY, DATASET, MODALITY and CALL_ID.
+             */
+            property?: string;
+        }
+    }
+    interface Filter {
+        /**
+         * What the filter narrows on. GET /v1/analytics/schema lists each type.
+         */
+        type: 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET' | 'METRIC_VALUE';
+        /**
+         * The value to compare against (an agent id, "call" / "chat", a property value).
+         */
+        value: string | number | boolean;
+        /**
+         * Defaults to EQUALS.
+         */
+        operator?: 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'CONTAINS' | 'STARTS_WITH';
+        /**
+         * The property to compare. Required for CALL_PROPERTY and METRIC_PROPERTY; may be
+         * omitted for AGENT_PROPERTY, DATASET, MODALITY and CALL_ID.
+         */
+        property?: string;
+    }
+    interface UnionMember0 {
+        type: 'LAST';
+        unit: 'DAYS' | 'WEEKS' | 'MONTHS';
+        value: number;
+    }
+    interface UnionMember1 {
+        period: 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR';
+        type: 'CALENDAR_ALIGNED';
+    }
+    interface UnionMember2 {
+        from: string;
+        to: string;
+        type: 'FIXED';
+    }
+    interface UnionMember3 {
+        from: string;
+        type: 'SINCE';
+    }
+}
+export declare namespace Analytics {
+    export { type AnalyticsGetSchemaResponse as AnalyticsGetSchemaResponse, type AnalyticsQueryResponse as AnalyticsQueryResponse, type AnalyticsQueryParams as AnalyticsQueryParams, };
+}
+//# sourceMappingURL=analytics.d.ts.map

package/resources/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/resources/analytics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAI3E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGhG;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,IAAI;QACnB,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAElC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzC,YAAY,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,CAAC,CAAC;QAE3E,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,SAAS,EAAE,KAAK,CAAC,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAEpD,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEtC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,SAAS,EAAE,KAAK,CACZ,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,0BAA0B,GAC1B,WAAW,GACX,uBAAuB,GACvB,UAAU,GACV,aAAa,CAChB,CAAC;KACH;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,SAAS;YACxB,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,EAAE,iBAAiB,GAAG,eAAe,GAAG,gBAAgB,GAAG,SAAS,CAAC;SAC1E;QAED,UAAiB,YAAY;YAC3B,QAAQ,EAAE,OAAO,CAAC;YAElB,IAAI,EAAE,MAAM,CAAC;YAEb,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC;YAEpB,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEnC,IAAI,EACA,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,cAAc,CAAC;SACpB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,QAAQ;gBACvB,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED,UAAiB,WAAW;YAC1B,YAAY,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;YAErG,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,EAAE,QAAQ,GAAG,cAAc,GAAG,QAAQ,CAAC;SAC5C;QAED,UAAiB,MAAM;YACrB,EAAE,EAAE,MAAM,CAAC;YAEX,YAAY,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;YAErG,kBAAkB,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;YAEpG,WAAW,EAAE,OAAO,CAAC;YAErB,IAAI,EAAE,MAAM,CAAC;YAEb,UAAU,EAAE,MAAM,CAAC;YAEnB,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,UAAiB,IAAI;QACnB,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;QAE5C,aAAa,EAAE,MAAM,CAAC;QAEtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzB,QAAQ,EAAE,MAAM,CAAC;QAEjB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,IAAI;YACnB,WAAW,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;YAE7F,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B,YAAY,EAAE,MAAM,CAAC;YAErB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,IAAI,EAAE,QAAQ,GAAG,cAAc,GAAG,QAAQ,CAAC;YAE3C,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,MAAM;gBACrB,IAAI,EAAE,MAAM,CAAC;gBAEb,KAAK,EAAE,MAAM,CAAC;gBAEd,cAAc,CAAC,EAAE,MAAM,CAAC;gBAExB,eAAe,CAAC,EAAE,MAAM,CAAC;gBAEzB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;aACrB;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;IAE/D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EACN,oBAAoB,CAAC,YAAY,GACjC,oBAAoB,CAAC,YAAY,GACjC,oBAAoB,CAAC,YAAY,GACjC,oBAAoB,CAAC,YAAY,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,OAAO;QACtB;;;;WAIG;QACH,WAAW,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;QAE9F;;;;WAIG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;QAE9B;;WAEG;QACH,KAAK,CAAC,EACF,OAAO,GACP,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,CAAC;QAEX;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEhC;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;QAEpG,2BAA2B,CAAC,EAAE,MAAM,CAAC;QAErC;;;WAGG;QACH,YAAY,CAAC,EACT,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,0BAA0B,GAC1B,WAAW,GACX,uBAAuB,GACvB,UAAU,GACV,aAAa,CAAC;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAEtC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,QAAQ,CAAC;KAC7C;IAED,UAAiB,OAAO,CAAC;QACvB;;;;WAIG;QACH,UAAiB,SAAS;YACxB,IAAI,EAAE,iBAAiB,GAAG,eAAe,GAAG,gBAAgB,GAAG,SAAS,CAAC;YAEzE;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EACA,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,cAAc,CAAC;YAEnB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;YAEjC;;eAEG;YACH,QAAQ,CAAC,EACL,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,0BAA0B,GAC1B,WAAW,GACX,uBAAuB,GACvB,UAAU,GACV,aAAa,CAAC;YAElB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;IAED,UAAiB,eAAe;QAC9B,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAEvC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,CAAC,EACF,OAAO,GACP,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,CAAC;KACZ;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EACA,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,cAAc,CAAC;YAEnB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;YAEjC;;eAEG;YACH,QAAQ,CAAC,EACL,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,0BAA0B,GAC1B,WAAW,GACX,uBAAuB,GACvB,UAAU,GACV,aAAa,CAAC;YAElB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EACA,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,cAAc,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EACL,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,0BAA0B,GAC1B,WAAW,GACX,uBAAuB,GACvB,UAAU,GACV,aAAa,CAAC;QAElB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;QAElC,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,YAAY;QAC3B,MAAM,EACF,OAAO,GACP,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,CAAC;QAEhB,IAAI,EAAE,kBAAkB,CAAC;KAC1B;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,MAAM,CAAC;QAEb,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,OAAO,CAAC;KACf;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/analytics.js

@@ -0,0 +1,55 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const resource_1 = require("../core/resource.js");
+class Analytics extends resource_1.APIResource {
+    /**
+     * Lists what can go into an analytics query for this project: every metric by slug
+     * with its output type, default aggregation and the aggregations it supports; the
+     * measure types; the filter and breakdown types with the properties each accepts;
+     * and the custom call properties seen in the project. Read this first when
+     * building a query.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.getSchema();
+     * ```
+     */
+    getSchema(options) {
+        return this._client.get('/v1/analytics/schema', options);
+    }
+    /**
+     * Aggregates metric values and conversation counts over a time window and returns
+     * one series per measure, with a total for the window and per-interval buckets.
+     * The same query a dashboard widget runs, without saving anything.
+     *
+     * - `measures`: what to aggregate. A METRIC measure names its metric by slug;
+     *   CONVERSATION counts conversations; UPTIME reads health checks. The aggregation
+     *   defaults by the metric's output type.
+     * - `timeRange`: LAST n DAYS/WEEKS/MONTHS, a CALENDAR_ALIGNED period (TODAY,
+     *   THIS_MONTH, ...), FIXED from/to, or SINCE. Defaults to the last 30 days; at
+     *   most 731 days. Calendar periods and buckets align to `timezone` (IANA, default
+     *   UTC).
+     * - `filters` apply to every measure; a measure's own `filters` add to them.
+     * - `breakdown` on a measure returns one series per value (largest 50 kept).
+     * - `comparisonGroups` (2 to 5) run every measure once per named filter set;
+     *   `comparisonMode: PREVIOUS_PERIOD` adds the preceding window's values.
+     *
+     * Values are in the metric's display units. A PASS_RATE is a 0 to 1 share;
+     * `sampleSize` 0 means no data. A query the analytics store cannot answer returns
+     * 400 naming the unsupported part.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.query({
+     *   measures: [{}],
+     * });
+     * ```
+     */
+    query(body, options) {
+        return this._client.post('/v1/analytics/query', { body, ...options });
+    }
+}
+exports.Analytics = Analytics;
+//# sourceMappingURL=analytics.js.map

package/resources/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../src/resources/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,IAA0B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAhDD,8BAgDC"}

package/resources/analytics.mjs

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Analytics extends APIResource {
+    /**
+     * Lists what can go into an analytics query for this project: every metric by slug
+     * with its output type, default aggregation and the aggregations it supports; the
+     * measure types; the filter and breakdown types with the properties each accepts;
+     * and the custom call properties seen in the project. Read this first when
+     * building a query.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.getSchema();
+     * ```
+     */
+    getSchema(options) {
+        return this._client.get('/v1/analytics/schema', options);
+    }
+    /**
+     * Aggregates metric values and conversation counts over a time window and returns
+     * one series per measure, with a total for the window and per-interval buckets.
+     * The same query a dashboard widget runs, without saving anything.
+     *
+     * - `measures`: what to aggregate. A METRIC measure names its metric by slug;
+     *   CONVERSATION counts conversations; UPTIME reads health checks. The aggregation
+     *   defaults by the metric's output type.
+     * - `timeRange`: LAST n DAYS/WEEKS/MONTHS, a CALENDAR_ALIGNED period (TODAY,
+     *   THIS_MONTH, ...), FIXED from/to, or SINCE. Defaults to the last 30 days; at
+     *   most 731 days. Calendar periods and buckets align to `timezone` (IANA, default
+     *   UTC).
+     * - `filters` apply to every measure; a measure's own `filters` add to them.
+     * - `breakdown` on a measure returns one series per value (largest 50 kept).
+     * - `comparisonGroups` (2 to 5) run every measure once per named filter set;
+     *   `comparisonMode: PREVIOUS_PERIOD` adds the preceding window's values.
+     *
+     * Values are in the metric's display units. A PASS_RATE is a 0 to 1 share;
+     * `sampleSize` 0 means no data. A query the analytics store cannot answer returns
+     * 400 naming the unsupported part.
+     *
+     * @example
+     * ```ts
+     * const response = await client.analytics.query({
+     *   measures: [{}],
+     * });
+     * ```
+     */
+    query(body, options) {
+        return this._client.post('/v1/analytics/query', { body, ...options });
+    }
+}
+//# sourceMappingURL=analytics.mjs.map

package/resources/analytics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../src/resources/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,IAA0B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}