@groundcover/api-client 0.9.0 → 0.11.0

package/dist/_generated/types.gen.d.ts

@@ -372,6 +372,56 @@ export type AssetFetchResult = {
      */
     type?: string;
 };
+/**
+ * AssetFunnel is the wet-mode hierarchical breakdown for one asset type.
+ *
+ * Unit names what Total counts: monitors are counted whole, dashboards are
+ * counted per widget.
+ */
+export type AssetFunnel = {
+    excluded?: ExcludedBucket;
+    not_supported?: NotSupportedBucket;
+    supported_converted?: SupportedConvertedBucket;
+    supported_not_converted?: SupportedNotConvertedBucket;
+    total?: number;
+    unit?: string;
+};
+/**
+ * AssetGapDetail describes one unit's gaps, counted once regardless of how many
+ * findings produced it.
+ */
+export type AssetGapDetail = {
+    asset_id?: string;
+    asset_name?: string;
+    datasources?: Array<string>;
+    keys?: Array<string>;
+    keys_by_datasource?: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * KeysByMetric and KeysByDatasource preserve which owner each missing key
+     * belongs to. Without them a unit missing a metric label and a log field
+     * reported both keys under the metric *and* under logs.
+     */
+    keys_by_metric?: {
+        [key: string]: Array<string>;
+    };
+    metrics?: Array<string>;
+    queries?: Array<ExecutedQuery>;
+    reason?: string;
+    /**
+     * SomeQueriesReturnedData distinguishes a unit where every query came back
+     * empty from one where only some did. Without it, a widget with nine working
+     * series and one broken one is indistinguishable from a wholly dead widget.
+     */
+    some_queries_returned_data?: boolean;
+    values?: Array<string>;
+    values_by_metric?: {
+        [key: string]: Array<string>;
+    };
+    widget_id?: string;
+    widget_title?: string;
+};
 export type AssetInstallResult = {
     /**
      * Error message if the installation failed.
@@ -1528,6 +1578,13 @@ export type ConvertMonitorResponse = {
     error?: string;
     success?: boolean;
 };
+/**
+ * CountPct is a count with percentage of its parent total.
+ */
+export type CountPct = {
+    count?: number;
+    pct?: number;
+};
 /**
  * CoverageAction defines an actionable step and its estimated query impact.
  */
@@ -2274,10 +2331,31 @@ export type DataScope = {
     advanced?: AdvancedDataScope;
     simple?: Group;
 };
+/**
+ * DataSetAvailableBucket is converted units whose underlying dataset exists in GC.
+ */
+export type DataSetAvailableBucket = {
+    /**
+     * Lookback is the widest window actually queried, so the report never claims
+     * a window it did not use.
+     */
+    lookback?: string;
+    no_data?: NoDataBreakdown;
+    returns_data?: CountPct;
+    total?: number;
+};
 /**
  * Datasource identifies the query backend.
  */
 export type Datasource = string;
+/**
+ * DatasourceKeyGap aggregates missing field keys for one search datasource.
+ */
+export type DatasourceKeyGap = {
+    count?: number;
+    datasource?: string;
+    keys?: Array<string>;
+};
 export type DeleteIngestionKeyRequest = {
     /**
      * Name of the ingestion key to delete
@@ -2584,6 +2662,40 @@ export type EventsSearchTimeSeriesRequest = {
      */
     valueField?: string;
 };
+/**
+ * ExcludedBucket counts units held out of the funnel because their only unmet
+ * dependency is Datadog's own telemetry: a self-observability metric, or one
+ * already inactive in Datadog. Migration quality has no bearing on either —
+ * they were never going to return data — so they are reported separately
+ * rather than weighing on supported/unsupported like a real gap would.
+ */
+export type ExcludedBucket = {
+    datadog_self_observability?: MetricListBucket;
+    inactive_in_datadog?: MetricListBucket;
+    total?: number;
+};
+/**
+ * ExecutedQuery is the evidence for a unit's wet outcome: the query that ran,
+ *
+ * the window it ran over, and what came back.
+ */
+export type ExecutedQuery = {
+    datasource?: string;
+    error?: string;
+    language?: string;
+    /**
+     * Metric names the query's underlying metric, for datasource == "metrics"
+     * only. Without it a metrics query that returned no data cannot be traced
+     * back to which metric was empty without parsing the query text.
+     */
+    metric?: string;
+    original_dd?: string;
+    query?: string;
+    query_id?: string;
+    resolved_query?: string;
+    status?: string;
+    window?: string;
+};
 /**
  * ExecutionPolicy defines model for ExecutionPolicy.
  */
@@ -2757,6 +2869,34 @@ export type Finding = {
     widget_id?: string;
     widget_title?: string;
 };
+/**
+ * FunnelAssetEntry maps one asset — or one dashboard widget — to the funnel stage
+ * it reached, with the queries that were executed as evidence.
+ */
+export type FunnelAssetEntry = {
+    asset_id?: string;
+    asset_name?: string;
+    asset_type?: string;
+    metrics?: Array<string>;
+    missing_keys?: Array<string>;
+    missing_values?: Array<string>;
+    queries?: Array<ExecutedQuery>;
+    reason?: string;
+    stage?: string;
+    widget_id?: string;
+    widget_title?: string;
+};
+/**
+ * FunnelByAsset is the per-asset view of the funnel: every monitor and every
+ * dashboard widget, with the stage it terminated at.
+ */
+export type FunnelByAsset = {
+    assets?: Array<FunnelAssetEntry>;
+    by_stage?: {
+        [key: string]: number;
+    };
+    total?: number;
+};
 export type GenericFiltersItem = {
     count?: number;
     name?: string;
@@ -3105,6 +3245,16 @@ export type IntegrationCount = {
     count?: number;
     name?: string;
 };
+/**
+ * IntegrationCountBucket counts units per data-source mapping.
+ */
+export type IntegrationCountBucket = {
+    by_integration?: {
+        [key: string]: number;
+    };
+    count?: number;
+    metrics?: Array<TaggedMetric>;
+};
 export type Integrations = {
     /**
      * Identity is the principal of the backend's own cloud (an AWS role ARN, a GCP
@@ -3257,6 +3407,19 @@ export type KeyMapping = {
     metric_pattern?: string;
     source_key?: string;
 };
+/**
+ * KeyMissingBreakdown groups units with missing keys.
+ *
+ * Metric label gaps and search field gaps are reported separately: a log or event
+ * field gap has no metric to attribute it to, and folding both into a by-metric
+ * view produced a meaningless "unknown" bucket.
+ */
+export type KeyMissingBreakdown = {
+    assets?: Array<AssetGapDetail>;
+    by_datasource?: Array<DatasourceKeyGap>;
+    by_metric?: Array<MetricKeyGap>;
+    count?: number;
+};
 export type KeysResponse = {
     isLimitReached?: boolean;
     keys?: Array<KeyItem>;
@@ -3815,6 +3978,21 @@ export type LogsInsightsRequestParams = {
     start?: string;
     threshold?: number;
 };
+/**
+ * LogsMissingBucket covers units whose log dataset is absent, including the case
+ * where the log source they filter on is not ingested into groundcover at all.
+ */
+export type LogsMissingBucket = {
+    assets?: Array<AssetGapDetail>;
+    count?: number;
+    known_sources?: Array<string>;
+    missing_sources?: Array<string>;
+    /**
+     * SourceNotIngested counts units filtering on a source:<value> that
+     * groundcover does not ingest, which no lookback widening can fix.
+     */
+    source_not_ingested?: number;
+};
 export type LogsPatternParamDistributionResponse = {
     values?: Array<PatternParamDistributionValue>;
 };
@@ -4150,6 +4328,14 @@ export type Metadata = {
     syntheticName?: string;
     target?: string;
 };
+/**
+ * MetricKeyGap aggregates missing label keys for one metric across units.
+ */
+export type MetricKeyGap = {
+    count?: number;
+    keys?: Array<string>;
+    metric?: string;
+};
 export type MetricKeysRequestV2 = {
     end?: string;
     filter?: string;
@@ -4165,10 +4351,25 @@ export type MetricKeysResponseV2 = {
 export type MetricLabels = {
     [key: string]: string;
 };
+/**
+ * MetricListBucket counts units and lists the metrics responsible.
+ */
+export type MetricListBucket = {
+    count?: number;
+    metrics?: Array<TaggedMetric>;
+};
 export type MetricMapping = {
     groundcover_metric?: string;
     source_metric?: string;
 };
+/**
+ * MetricValueGap aggregates missing label values for one metric.
+ */
+export type MetricValueGap = {
+    count?: number;
+    metric?: string;
+    values?: Array<string>;
+};
 export type MetricValuesRequestV2 = {
     conditions?: Array<Condition>;
     end?: string;
@@ -4477,6 +4678,32 @@ export type MigrationDetectedIntegration = {
      */
     metricCount: number;
 };
+/**
+ * MissingDataSetBucket covers converted units whose underlying dataset is absent.
+ */
+export type MissingDataSetBucket = {
+    logs?: LogsMissingBucket;
+    metrics?: MissingMetricsBreakdown;
+    missing_env?: ValueMissingBucket;
+    tail?: TailDataSetBreakdown;
+    total?: number;
+};
+/**
+ * MissingMetricsBreakdown splits missing metrics into mutually exclusive buckets.
+ *
+ * A metric can qualify for several buckets at once (a datadog.* metric that is
+ * also inactive, say). It is counted in exactly one — chosen by the priority
+ * order in classifyMissingMetric — and carries a tag for every bucket that
+ * applies, so nothing is lost to that choice.
+ */
+export type MissingMetricsBreakdown = {
+    custom_metrics?: MetricListBucket;
+    datadog_self_observability?: MetricListBucket;
+    inactive_in_datadog?: MetricListBucket;
+    integrations_we_dont_have?: IntegrationCountBucket;
+    integrations_we_have?: IntegrationCountBucket;
+    total?: number;
+};
 /**
  * Model holds the core query/reducer/threshold definitions.
  */
@@ -4643,6 +4870,41 @@ export type MonitorVariable = {
     search?: VariableSearch;
     storage?: string;
 };
+/**
+ * NoDataBreakdown drills into units that did not come back fully working.
+ *
+ * A unit lands here when any of its queries returned no data, or when a static
+ * key/value gap was found. For a multi-query unit — a widget with several series,
+ * a monitor with a formula — that means "not all queries returned data" rather
+ * than "nothing returned data"; SomeQueriesReturnedData on each entry records
+ * which of the two it was.
+ */
+export type NoDataBreakdown = {
+    count?: number;
+    negative_key_missing?: KeyMissingBreakdown;
+    negative_value_missing?: ValueMissingBucket;
+    pct?: number;
+    positive_all_keys_values_exist?: PositiveNoDataBucket;
+};
+/**
+ * NoDataNeededBucket counts units that need no query to render.
+ */
+export type NoDataNeededBucket = {
+    by_type?: {
+        [key: string]: number;
+    };
+    count?: number;
+};
+/**
+ * NotSupportedBucket covers unsupported types, bucketed by type.
+ */
+export type NotSupportedBucket = {
+    assets?: Array<AssetGapDetail>;
+    by_type?: {
+        [key: string]: number;
+    };
+    total?: number;
+};
 export type NotificationRouteListItemResponse = {
     /**
      * The creation timestamp
@@ -4970,11 +5232,29 @@ export type PolicyWithEntityCount = Policy & {
      */
     readonly entityCount?: number;
 };
+/**
+ * PositiveNoDataBucket covers units where every dependency resolves yet no data
+ * came back, broken down by the reason we could establish.
+ */
+export type PositiveNoDataBucket = {
+    assets?: Array<AssetGapDetail>;
+    by_reason?: OrderedReasons;
+    count?: number;
+    pct?: number;
+};
 /**
  * PreflightReport is the top-level structured output of a preflight validation run.
  */
 export type PreflightReport = {
     coverage_plan?: CoveragePlan;
+    funnel_by_asset?: FunnelByAsset;
+    /**
+     * GeneratedAt is when this report was produced, set once right before it is
+     * written out. A report is often diffed against a later rerun after a fix, so
+     * the file needs to say for itself when it was taken without relying on
+     * filesystem mtimes, which a copy or a git checkout does not preserve.
+     */
+    generated_at?: string;
     integrations_summary?: Array<IntegrationCount>;
     raw_findings?: Array<Finding>;
     summary?: UnifiedSummary;
@@ -5695,12 +5975,25 @@ export type ServiceAccountsWithPolicy = {
     serviceAccountId?: string;
 };
 export type Session = {
+    /**
+     * AppVersion is the mobile application version. Empty for web sessions, which
+     * report ReleaseID instead.
+     */
+    appVersion?: string;
     browser?: string;
     country?: string;
+    deviceBrand?: string;
+    deviceModel?: string;
     durationMilli?: number;
     endTime?: string;
     hasSessionReplay?: number;
     isMobile?: string;
+    /**
+     * Mobile RUM. Empty for web sessions, which report browser.* instead. The client
+     * platform is not returned: it is a filter dimension only.
+     */
+    osName?: string;
+    osVersion?: string;
     pageCount?: number;
     releaseId?: string;
     serviceName?: string;
@@ -5712,6 +6005,11 @@ export type Session = {
     userOrganization?: string;
 };
 export type SessionDetailsRequestParams = {
+    /**
+     * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
+     * React Native. Defaults to 'rum' when omitted.
+     */
+    category?: 'rum' | 'mobile-rum';
     conditions?: Array<Condition>;
     end?: string;
     sessionID?: string;
@@ -5789,6 +6087,11 @@ export type SessionReplayVelocityResponse = {
     series?: Array<MetricVelocityWithLabels>;
 };
 export type SessionsFiltersRequestParams = {
+    /**
+     * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
+     * React Native. Defaults to 'rum' when omitted.
+     */
+    category?: 'rum' | 'mobile-rum';
     conditions?: Array<Condition>;
     end?: string;
     required?: Array<Column>;
@@ -5799,11 +6102,21 @@ export type SessionsFiltersResponse = {
     filters?: FiltersWithEstimatedMapResponse;
 };
 export type SessionsQueryRequestParams = {
+    /**
+     * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
+     * React Native. Defaults to 'rum' when omitted.
+     */
+    category?: 'rum' | 'mobile-rum';
     conditions?: Array<Condition>;
     end?: string;
     limit?: number;
     skip?: number;
-    sortBy?: string;
+    /**
+     * Interpolated raw into ORDER BY, so this list is the only guard - and it is
+     * version-independent while the template is version-selected, so every value
+     * needs an alias in all three variants. Keep the enum below in lockstep.
+     */
+    sortBy?: 'sessionID' | 'startTime' | 'endTime' | 'userEmail' | 'userId' | 'country' | 'isMobile' | 'browser' | 'sessionErrors' | 'pageCount' | 'durationMilli' | 'osName' | 'deviceModel';
     sortOrder?: string;
     sources?: Array<Condition>;
     start?: string;
@@ -5812,6 +6125,11 @@ export type SessionsQueryResponse = {
     sessions?: Array<Session>;
 };
 export type SessionsSummaryRequestParams = {
+    /**
+     * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
+     * React Native. Defaults to 'rum' when omitted.
+     */
+    category?: 'rum' | 'mobile-rum';
     conditions?: Array<Condition>;
     end?: string;
     sources?: Array<Condition>;
@@ -6089,10 +6407,47 @@ export type Subject = {
  */
 export type Suggestion = {
     confidence?: number;
-    reason?: string;
+    reasons?: Array<SuggestionReason>;
     type?: string;
     value?: string;
 };
+/**
+ * SuggestionReason is one scoring signal that contributed to a Suggestion.
+ *
+ * Weight is the signal's additive contribution within the scorer that produced
+ * it. Name-similarity signals and value-overlap signals are scored
+ * independently, so when both back the same candidate the suggestion carries
+ * reasons from each and Confidence is the higher of the two estimates rather
+ * than their sum — weights add up within a scorer, not across them.
+ *
+ * Detail carries the evidence behind the signal. For value-overlap signals that
+ * means the matched values themselves, which is what makes the difference
+ * between a suggestion worth acting on and one worth eyeballing.
+ */
+export type SuggestionReason = {
+    code?: string;
+    detail?: string;
+    weight?: number;
+};
+/**
+ * SupportedConvertedBucket covers units that converted successfully.
+ */
+export type SupportedConvertedBucket = {
+    data_set_available?: DataSetAvailableBucket;
+    missing_underlying_data_set?: MissingDataSetBucket;
+    no_data_needed?: NoDataNeededBucket;
+    total?: number;
+};
+/**
+ * SupportedNotConvertedBucket covers supported types that failed conversion.
+ */
+export type SupportedNotConvertedBucket = {
+    assets?: Array<AssetGapDetail>;
+    by_error?: {
+        [key: string]: number;
+    };
+    total?: number;
+};
 /**
  * SyntheticMonitorConfig represents optional monitor configuration overrides for a synthetic test.
  *
@@ -6209,6 +6564,21 @@ export type SyntheticsCheckInput = {
     checkConfig?: WorkerRequest;
     interval?: string;
 };
+/**
+ * TaggedMetric names a metric plus every classification that applies to it.
+ */
+export type TaggedMetric = {
+    metric?: string;
+    tags?: Array<string>;
+};
+/**
+ * TailDataSetBreakdown covers non-metrics/logs datasets.
+ */
+export type TailDataSetBreakdown = {
+    events?: number;
+    rum?: number;
+    traces?: number;
+};
 /**
  * +enum
  */
@@ -7069,13 +7439,19 @@ export type UnfurlTraceSummary = {
  * UnifiedSummary is the single hierarchical summary included in JSON output.
  */
 export type UnifiedSummary = {
-    affected_assets_by_type?: {
+    assets?: AssetsSummary;
+    /**
+     * AssetsByFindingType is the distribution of affected assets per finding
+     * type, keyed by asset type.
+     */
+    assets_by_finding_type?: {
         [key: string]: {
             [key: string]: number;
         };
     };
-    assets?: AssetsSummary;
     conversion?: ConversionSummary;
+    dashboards?: AssetFunnel;
+    monitors?: AssetFunnel;
     queries?: QueriesSummary;
     wet_validation?: WetValidationSummary;
 };
@@ -7516,6 +7892,14 @@ export type ValueItem = {
     types?: Array<string>;
     value?: string;
 };
+/**
+ * ValueMissingBucket lists units whose filter values are absent in groundcover.
+ */
+export type ValueMissingBucket = {
+    assets?: Array<AssetGapDetail>;
+    by_metric?: Array<MetricValueGap>;
+    count?: number;
+};
 export type ValuesDistributionRequest = {
     conditions?: Array<Condition>;
     /**
@@ -7717,14 +8101,31 @@ export type WetResult = {
     asset_type?: string;
     datasource?: Datasource;
     error?: string;
+    /**
+     * HasFreeText mirrors WetQuery.HasFreeText.
+     */
+    has_free_text?: boolean;
     latency?: Duration;
+    /**
+     * Metric mirrors WetQuery.Metric.
+     */
+    metric?: string;
     original_dd?: string;
     query?: string;
     query_id?: string;
     query_type?: QueryType;
     resolved_query?: string;
     status?: WetStatus;
+    widget_id?: string;
     widget_title?: string;
+    /**
+     * Window is the span actually queried:
+     * "5m"          progressive first pass
+     * "30m"         dashboard long pass
+     * "7d"          monitor long pass (or whatever --wet-monitor-lookback sets)
+     * "instant"     instant query answered at a single point in time
+     * "instant→7d"  instant query was empty, so it was re-run as a range
+     */
     window?: string;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groundcover/api-client",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "groundcover TypeScript API Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",