@salesforce/lds-adapters-sfap-analytics-insights 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1198 @@
+#%RAML 1.0
+types:
+  SummaryResponse:
+    type: object
+    properties:
+      result: Summary
+      error:
+        type: Error
+        required: false
+  InsightGroup:
+    type: object
+    properties:
+      type:
+        type: string
+        required: false
+      insights:
+        type: array
+        items: InsightResponse
+        required: false
+      overviews:
+        type: array
+        items: OverviewResponse
+        required: false
+      error:
+        type: Error
+        required: false
+  GetFilterValuesResponse_CategoricalValues:
+    type: object
+    properties:
+      values:
+        description: |-
+          Single page of field values. grpc built-in generic value that covers all data types.
+           Support both text field(e.g. State, City) and discrete numeric field(E.g. Postal Code)
+        type: array
+        items:
+          type: string | number | boolean | nil
+        required: false
+  InsightsOptions_InsightSetting:
+    type: object
+    properties:
+      type:
+        enum:
+          - INSIGHT_TYPE_UNSPECIFIED
+          - INSIGHT_TYPE_RISKY_MONOPOLY
+          - INSIGHT_TYPE_TOP_DRIVERS
+          - INSIGHT_TYPE_RECORD_LEVEL_OUTLIERS
+          - INSIGHT_TYPE_CURRENT_TREND
+          - INSIGHT_TYPE_NEW_TREND
+          - INSIGHT_TYPE_TOP_DIMENSION_MEMBER_MOVERS
+          - INSIGHT_TYPE_METRIC_FORECAST
+          - INSIGHT_TYPE_BOTTOM_CONTRIBUTORS
+          - INSIGHT_TYPE_TOP_DETRACTORS
+        type: string
+        (amf-format): enum
+        required: false
+      disabled:
+        type: boolean
+        required: false
+  MetricMetadata:
+    type: object
+    properties:
+      name:
+        type: string
+        required: false
+      definitionId:
+        type: string
+        required: false
+  InsightResponse:
+    type: object
+    properties:
+      result:
+        type: Insight
+        required: false
+      error:
+        type: Error
+        required: false
+      insightType:
+        type: string
+        required: false
+  GenerateInsightBundleV2Request:
+    type: object
+    properties:
+      type:
+        description: The bundle type to request
+        enum:
+          - INSIGHT_BUNDLE_TYPE_UNSPECIFIED
+          - INSIGHT_BUNDLE_TYPE_BAN
+          - INSIGHT_BUNDLE_TYPE_SPRINGBOARD
+          - INSIGHT_BUNDLE_TYPE_DETAIL
+          - INSIGHT_BUNDLE_TYPE_BASIC
+        type: string
+        (amf-format): enum
+        required: false
+      version:
+        description: The version of the bundle type to request
+        type: number
+        format: int32
+        required: false
+      sdmId:
+        type: string
+        required: false
+      metricId:
+        type: string
+        required: false
+      metricInstance: MetricInstance
+      comparison:
+        description: For period over period insights, whether the comparison period is the prior period, or the same period the previous year. If not specified, defaults to TIME_COMPARISON_PREVIOUS_PERIOD
+        enum:
+          - TIME_COMPARISON_UNSPECIFIED
+          - TIME_COMPARISON_NONE
+          - TIME_COMPARISON_PREVIOUS_PERIOD
+          - TIME_COMPARISON_YEAR_AGO_PERIOD
+        type: string
+        (amf-format): enum
+        required: false
+      bundleId:
+        description: An identifier used in logging (ie. A client could use the submetric id here)
+        type: string
+        required: false
+      options:
+        description: Options affecting the generation of the bundle
+        (amf-and):
+          - InsightBundleOptions
+        type: any
+        required: false
+  GoalMetadata_StatusCondition:
+    type: object
+    properties:
+      statusName:
+        type: string
+        required: false
+      value:
+        type: string
+        required: false
+      operator:
+        enum:
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - LessThan
+          - LessThanOrEqualTo
+          - Equals
+        type: string
+        (amf-format): enum
+        required: false
+      color:
+        enum:
+          - CloudBlue
+          - Green
+          - Indigo
+          - Pink
+          - Red
+          - Teal
+          - Violet
+          - Yellow
+        type: string
+        (amf-format): enum
+        required: false
+      currencyIsoCode:
+        type: string
+        required: false
+      primary:
+        type: boolean
+        required: false
+  Insight:
+    type: object
+    properties:
+      type:
+        type: string
+        required: false
+      version:
+        type: number
+        format: int32
+        required: false
+      markup:
+        type: string
+        required: false
+      viz:
+        type: any
+        required: false
+      facts:
+        type: any
+        required: false
+      characterization:
+        enum:
+          - CHARACTERIZATION_UNSPECIFIED
+          - CHARACTERIZATION_NORMAL
+          - CHARACTERIZATION_UNUSUAL
+        type: string
+        (amf-format): enum
+        required: false
+      question:
+        type: string
+        required: false
+      score:
+        type: number
+        format: double
+        required: false
+      id:
+        type: string
+        required: false
+      insightFeedbackMetadata: InsightFeedbackMetadata
+  Error:
+    type: object
+    properties:
+      code:
+        type: string
+        required: false
+      message:
+        type: string
+        required: false
+  SemanticDataModel:
+    type: object
+    properties:
+      apiName:
+        type: string
+        required: false
+  MetricDefinition:
+    type: object
+    properties:
+      semanticDataModel: SemanticDataModel
+      measure: Measure
+      timeDimension: TimeDimension
+      comparison: CompareConfig
+      filters:
+        description: DEPRECATED Please don't use this field.
+        type: array
+        items: Filter
+        required: false
+      runningTotal:
+        type: boolean
+        required: false
+      semanticFilter:
+        description: The 'filters' and 'semantic_filters' will be ANDed together
+        type: FlattenFilter
+        required: false
+  MeasurementPeriod:
+    type: object
+    properties:
+      filter:
+        description: |-
+          DEPRECATED Please don't use this field.
+          Server side, we validate that :
+             1. the filter type is 'range' or 'relative-date'
+             2. the field is date or date-time field on the SDM
+        type: Filter
+        required: false
+      relativePeriod:
+        description: |-
+          DEPRECATED Please don't use this field.
+          Define the measurement period with a granularity and a range
+        type: RelativePeriod
+        required: false
+      semanticFilter:
+        description: |-
+          We do not yet have support for fiscal year
+            We do not yet have support for unbounded time ranges (less than/greater than/all time)
+        (amf-and):
+          - FlattenFilter
+        type: any
+        required: false
+  RelativeDate:
+    type: object
+    properties:
+      periodType:
+        description: |-
+          The dashboard equivalent to granularity.
+           Acceptable values for insights are
+           'years'/ 'year'
+           'fiscal-years' / 'fiscal-year'
+           'quarters'/ 'quarter'
+           'fiscal-quarters' / 'fiscal-quarter
+           'months'/ 'month'
+           'weeks'/ 'week'
+           'days'/ 'day'
+        type: string
+        required: false
+      rangeType:
+        description: |-
+          A description of the relative nature of the range
+           Acceptable values are
+           'last'
+           'last-n'
+           'next'
+           'next-n'
+           'current'
+        type: string
+        required: false
+      rangeN:
+        description: |-
+          ignored for range_types that are not "last-n"
+           if negative (and not ignored), will result in an error
+        type: number
+        format: int32
+        required: false
+  RelativePeriod:
+    description: The old insights time filter
+    type: object
+    properties:
+      granularity:
+        enum:
+          - GRANULARITY_UNSPECIFIED
+          - GRANULARITY_BY_YEAR
+          - GRANULARITY_BY_QUARTER
+          - GRANULARITY_BY_MONTH
+          - GRANULARITY_BY_WEEK
+          - GRANULARITY_BY_DAY
+          - GRANULARITY_BY_FISCAL_QUARTER
+        type: string
+        (amf-format): enum
+        required: false
+      range:
+        enum:
+          - RANGE_UNSPECIFIED
+          - RANGE_CURRENT_PARTIAL
+          - RANGE_LAST_COMPLETE
+        type: string
+        (amf-format): enum
+        required: false
+  FieldId:
+    type: object
+    properties:
+      datasource:
+        type: string
+        required: false
+      objectName:
+        type: string
+        required: false
+      fieldName:
+        type: string
+        required: false
+  RangeFilterOptions:
+    type: object
+    properties:
+      min:
+        (amf-xone):
+          - type: number
+          - type: string
+          - type: boolean
+        type: any
+        required: false
+      max:
+        (amf-xone):
+          - type: number
+          - type: string
+          - type: boolean
+        type: any
+        required: false
+      nullOption:
+        type: string
+        required: false
+      excludeMin:
+        type: boolean
+        required: false
+      excludeMax:
+        type: boolean
+        required: false
+  InsightsOptions:
+    type: object
+    properties:
+      settings:
+        type: array
+        items: InsightsOptions_InsightSetting
+        required: false
+  InsightBundle:
+    type: object
+    properties:
+      insightGroups:
+        description: The insight groups returned are determined by the bundle type
+        type: array
+        items: InsightGroup
+        required: false
+      hasErrors:
+        description: Whether or not any errors were encountered when generating the bundle
+        type: boolean
+        required: false
+      characterization:
+        description: The overall characterization of the bundle
+        enum:
+          - CHARACTERIZATION_UNSPECIFIED
+          - CHARACTERIZATION_NORMAL
+          - CHARACTERIZATION_UNUSUAL
+        type: string
+        (amf-format): enum
+        required: false
+  GenerateInsightBatchResponse:
+    type: object
+    properties:
+      batchId:
+        description: ID of the batch being generated
+        type: string
+        required: true
+      summary:
+        description: If a cached summary exists, return the summary immediately
+        type: SummaryResponse
+        required: false
+      timestamp:
+        description: |-
+          If a cached summary exists, return a timestamp of the cached summary
+           generation in UTC
+        type: string
+        required: false
+      generatingSummary:
+        description: Lets client know if summary is being generated
+        type: boolean
+        required: false
+  MetricInstance:
+    type: object
+    properties:
+      measurementPeriod:
+        (amf-and):
+          - MeasurementPeriod
+        type: any
+        required: false
+      filters:
+        description: |-
+          DEPRECATED Please don't use this field.
+          The 'filters' and 'semantic_filters' will be ANDed together
+        type: array
+        items: Filter
+        required: false
+      semanticFilter:
+        type: FlattenFilter
+        required: false
+      goals:
+        type: GoalMetadata
+        required: false
+  BatchInput:
+    type: object
+    properties:
+      bundleInput:
+        type: InsightBundleInput
+        required: false
+      metricInstanceInput:
+        type: MetricInstanceInput
+        required: false
+  OverviewResponse:
+    type: object
+    properties:
+      result:
+        type: Overview
+        required: false
+      error:
+        type: Error
+        required: false
+  InputMetric:
+    type: object
+    properties:
+      metric: MetricDefinition
+      instance: MetricInstance
+      extensionOptions: ExtensionOptions
+      representationOptions: RepresentationOptions
+      insightsOptions: InsightsOptions
+      goals:
+        type: GoalMetadata
+        required: false
+  TimeDimension:
+    type: object
+    properties:
+      field: FieldId
+  RepresentationOptions:
+    type: object
+    properties:
+      type:
+        enum:
+          - NUMBER_FORMAT_TYPE_UNSPECIFIED
+          - NUMBER_FORMAT_TYPE_NUMBER
+          - NUMBER_FORMAT_TYPE_PERCENT
+          - NUMBER_FORMAT_TYPE_CURRENCY
+        type: string
+        (amf-format): enum
+        required: false
+      numberUnits: RepresentationOptions_NumberUnits
+      sentimentType:
+        enum:
+          - SENTIMENT_TYPE_UNSPECIFIED
+          - SENTIMENT_TYPE_NONE
+          - SENTIMENT_TYPE_UP_IS_GOOD
+          - SENTIMENT_TYPE_DOWN_IS_GOOD
+        type: string
+        (amf-format): enum
+        required: false
+  GenerateInsightBundleRequest:
+    type: object
+    properties:
+      type:
+        description: The bundle type to request
+        enum:
+          - INSIGHT_BUNDLE_TYPE_UNSPECIFIED
+          - INSIGHT_BUNDLE_TYPE_BAN
+          - INSIGHT_BUNDLE_TYPE_SPRINGBOARD
+          - INSIGHT_BUNDLE_TYPE_DETAIL
+          - INSIGHT_BUNDLE_TYPE_BASIC
+        type: string
+        (amf-format): enum
+        required: false
+      version:
+        description: The version of the bundle type to request
+        type: number
+        format: int32
+        required: false
+      input:
+        description: The input to the bundle type
+        type: InsightBundleInput
+        required: false
+      options:
+        description: Options affecting the generation of the bundle
+        type: InsightBundleOptions
+        required: false
+  FlattenFilter:
+    description: |-
+      *
+       Represents a flattened filter
+    type: object
+    properties:
+      filterLogic:
+        type: string
+        required: false
+      filters:
+        type: array
+        items: SemanticFilter
+        required: false
+  InsightFeedbackMetadata:
+    type: object
+    properties:
+      type:
+        type: string
+        required: false
+      score:
+        type: number
+        format: double
+        required: false
+      dimensionHash:
+        type: string
+        required: false
+  GenerateInsightBundleResponse:
+    type: object
+    properties:
+      result:
+        description: |-
+          Note that it is possible that we encountered some errors but were still
+           able to compute part of the result. In that case, the result key will be
+           present, and there will be errors at the appropriate level inside
+        type: InsightBundle
+        required: false
+      error:
+        type: Error
+        required: false
+      submetric:
+        description: IDs of the bundle response, for caching and identifiation
+        type: string
+        required: true
+      sdm:
+        type: string
+        required: true
+      measurementPeriod:
+        type: UnifiedFilter
+        required: false
+  CategoricalFilterOptions:
+    type: object
+    properties:
+      operator:
+        type: string
+        required: false
+      values:
+        type: array
+        items:
+          (amf-xone):
+            - type: number
+            - type: string
+            - type: boolean
+          type: any
+        required: false
+      nullOption:
+        description: "To include or exclude null values. Options: ''null-values'', ''non-null-values'', ''all-values''"
+        type: string
+        required: false
+  InsightBundleOptions:
+    type: object
+    properties:
+      outputFormat:
+        description: Used to determine the type of markup to return for the insight text
+        enum:
+          - OUTPUT_FORMAT_UNSPECIFIED
+          - OUTPUT_FORMAT_HTML
+          - OUTPUT_FORMAT_TEXT
+        type: string
+        (amf-format): enum
+        required: false
+      now:
+        description: |-
+          A string of the format "YYYY-MM-DD HH:MM:SS" or "YYYY-MM-DD" or empty.
+           If no time is specified, then midnight ("00:00:00") is used.
+           Hours must be in 24-hr format (00 to 23).
+           If provided, analysis will be done as if this is the current date/time.
+           If not provided, then the current date/time will be used.
+        type: string
+        required: false
+      timeZone:
+        description: |-
+          A string of the format used in the IANA Time Zone database, e.g. "America/Vancouver"
+           See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+           If not provided, will default to "UTC"
+        type: string
+        required: false
+  ExtensionOptions:
+    type: object
+    properties:
+      analysisDimensions:
+        type: array
+        items:
+          type: string
+        required: false
+      minimumGranularity:
+        enum:
+          - GRANULARITY_UNSPECIFIED
+          - GRANULARITY_BY_YEAR
+          - GRANULARITY_BY_QUARTER
+          - GRANULARITY_BY_MONTH
+          - GRANULARITY_BY_WEEK
+          - GRANULARITY_BY_DAY
+          - GRANULARITY_BY_FISCAL_QUARTER
+        type: string
+        (amf-format): enum
+        required: false
+  MetricInstanceInput:
+    type: object
+    properties:
+      metricInstanceId:
+        type: string
+        required: true
+      sdmId:
+        type: string
+        required: true
+      measurementPeriod:
+        type: UnifiedFilter
+        required: false
+  RepresentationOptions_NumberUnits:
+    type: object
+    properties:
+      singularNoun:
+        type: string
+        required: false
+      pluralNoun:
+        type: string
+        required: false
+  CompareConfig:
+    type: object
+    properties:
+      comparison:
+        enum:
+          - TIME_COMPARISON_UNSPECIFIED
+          - TIME_COMPARISON_NONE
+          - TIME_COMPARISON_PREVIOUS_PERIOD
+          - TIME_COMPARISON_YEAR_AGO_PERIOD
+        type: string
+        (amf-format): enum
+        required: false
+  GetInsightBatchResponse:
+    type: object
+    properties:
+      batchId:
+        description: ID of the batch that was requested
+        type: string
+        required: true
+      status:
+        description: Current status of the batch
+        enum:
+          - BATCH_STATUS_UNSPECIFIED
+          - BATCH_STATUS_GENERATING
+          - BATCH_STATUS_COMPLETED
+          - BATCH_STATUS_ERRORED
+        type: string
+        (amf-format): enum
+        required: false
+      bundles:
+        description: Bundle responses for all requested bundles in the batch
+        type: array
+        items: GenerateInsightBundleResponse
+        required: false
+      hasErrors:
+        description: Flag denoting if any insights encountered errors during generation
+        type: boolean
+        required: false
+      summary:
+        description: Summary generated by GAI
+        type: SummaryResponse
+        required: false
+  Overview:
+    type: object
+    properties:
+      viz:
+        type: any
+        required: false
+      status:
+        type: Status
+        required: false
+  RelativeDateFilterOptions:
+    type: object
+  GetFilterValuesResponse:
+    type: object
+    properties:
+      categoricalValues: GetFilterValuesResponse_CategoricalValues
+      nextPageToken:
+        type: string
+        required: false
+      totalAvailable:
+        type: number
+        format: int32
+        required: false
+      id:
+        type: string
+        required: true
+  InsightBundleInput:
+    type: object
+    properties:
+      metadata: MetricMetadata
+      metric: InputMetric
+  SummarizationOptions:
+    type: object
+    properties:
+      strategy:
+        description: The strategy to use for the summary
+        enum:
+          - SUMMARIZATION_STRATEGY_UNSPECIFIED
+          - SUMMARIZATION_STRATEGY_DIGEST
+        type: string
+        (amf-format): enum
+        required: false
+  BatchOptions:
+    type: object
+    properties:
+      bundle:
+        description: Options to apply to each insight bundle
+        type: InsightBundleOptions
+        required: false
+      summarization:
+        description: Options to apply to desired summary
+        type: SummarizationOptions
+        required: false
+      skipCache:
+        description: Option to skip checking for batch/summary in cache
+        type: boolean
+        required: false
+  GenerateInsightBatchRequest:
+    type: object
+    properties:
+      batchInput:
+        description: Either fully formed bundles or metric instance IDs
+        type: array
+        items: BatchInput
+        required: false
+      options:
+        description: Options to apply to the entire batch
+        type: BatchOptions
+        required: false
+  Filter:
+    description: The old dashboard-style filter
+    type: object
+    properties:
+      type:
+        description: |-
+          Acceptable types are:
+           'categorical'
+           'range'
+           'relative-date'
+        type: string
+        required: false
+      field:
+        type: FieldId
+        required: false
+      fieldId:
+        type: FieldId
+        required: false
+      categoricalFilterOptions:
+        type: CategoricalFilterOptions
+        required: false
+      rangeFilterOptions:
+        type: RangeFilterOptions
+        required: false
+      relativeDateFilterOptions:
+        type: RelativeDateFilterOptions
+        required: false
+  GoalMetadata:
+    type: object
+    properties:
+      statusConditions:
+        type: array
+        items: GoalMetadata_StatusCondition
+        required: false
+      forecasting:
+        type: boolean
+        required: false
+  UnifiedFilter:
+    description: Message representing the Unified Filter.
+    type: object
+    properties:
+      fieldName:
+        description: tableName.ColumnName or calcFieldName
+        type: string
+        required: false
+      operator:
+        enum:
+          - Equals
+          - DoesNotEquals
+          - EqualsIgnoreCase
+          - DoesNotEqualsIgnoreCase
+          - Between
+          - LessThan
+          - LessThanOrEqualTo
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - IsEmpty
+          - IsNotEmpty
+          - Contains
+          - ContainsIgnoreCase
+          - NotContains
+          - NotContainsIgnoreCase
+          - StartsWith
+          - StartsWithIgnoreCase
+          - DoesNotStartWith
+          - DoesNotStartWithIgnoreCase
+          - EndsWith
+          - EndsWithIgnoreCase
+          - DoesNotEndWith
+          - DoesNotEndWithIgnoreCase
+          - IsNull
+          - IsNotNull
+          - LastNDays
+          - NextNDays
+          - PreviousWeek
+          - CurrentWeek
+          - NextWeek
+          - PreviousMonth
+          - CurrentMonth
+          - NextMonth
+          - PreviousQuarter
+          - CurrentQuarter
+          - NextQuarter
+          - PreviousYear
+          - CurrentYear
+          - NextYear
+          - PreviousFiscalQuarter
+          - CurrentFiscalQuarter
+          - NextFiscalQuarter
+          - PreviousFiscalYear
+          - CurrentFiscalYear
+          - NextFiscalYear
+          - PreviousMonthToDate
+          - CurrentMonthToDate
+          - PreviousQuarterToDate
+          - CurrentQuarterToDate
+          - PreviousYearToDate
+          - CurrentYearToDate
+          - PreviousFiscalQuarterToDate
+          - CurrentFiscalQuarterToDate
+          - PreviousFiscalYearToDate
+          - CurrentFiscalYearToDate
+          - Values
+          - In
+          - NotIn
+        type: string
+        (amf-format): enum
+        required: false
+      values:
+        description: An array of values. All values must be of the same type. We support  strings, numbers, and booleans.
+        type: array
+        items:
+          (amf-xone):
+            - type: number
+            - type: string
+            - type: boolean
+          type: any
+        required: false
+  GetFilterValuesRequest:
+    type: object
+    properties:
+      semanticDataModel: SemanticDataModel
+      field: FieldId
+      pageToken:
+        type: string
+        required: false
+      pageSize:
+        description: Page size specifies the maximum number of values to return on a query. It has a maximum of 1000.
+        type: number
+        format: int32
+        required: false
+      searchTerm:
+        description: Specifies to look for field values that contain the search_term
+        type: string
+        required: false
+      filters:
+        type: array
+        items: Filter
+        required: false
+      semanticFilter:
+        description: The 'filters' and 'semantic_filter' will be ANDed together
+        type: FlattenFilter
+        required: false
+  SemanticFilter:
+    description: Message representing Semantic Filter.
+    type: object
+    properties:
+      fieldName:
+        type: string
+        required: true
+      operator:
+        enum:
+          - SEMANTIC_FILTER_OPERATOR_TYPE_UNSPECIFIED
+          - Equals
+          - DoesNotEquals
+          - EqualsIgnoreCase
+          - DoesNotEqualsIgnoreCase
+          - Between
+          - LessThan
+          - LessThanOrEqualTo
+          - GreaterThan
+          - GreaterThanOrEqualTo
+          - IsEmpty
+          - IsNotEmpty
+          - Contains
+          - ContainsIgnoreCase
+          - NotContains
+          - NotContainsIgnoreCase
+          - StartsWith
+          - StartsWithIgnoreCase
+          - DoesNotStartWith
+          - DoesNotStartWithIgnoreCase
+          - EndsWith
+          - EndsWithIgnoreCase
+          - DoesNotEndWith
+          - DoesNotEndWithIgnoreCase
+          - IsNull
+          - IsNotNull
+          - LastNDays
+          - NextNDays
+          - PreviousWeek
+          - CurrentWeek
+          - NextWeek
+          - PreviousMonth
+          - CurrentMonth
+          - NextMonth
+          - PreviousQuarter
+          - CurrentQuarter
+          - NextQuarter
+          - PreviousYear
+          - CurrentYear
+          - NextYear
+          - PreviousFiscalQuarter
+          - CurrentFiscalQuarter
+          - NextFiscalQuarter
+          - PreviousFiscalYear
+          - CurrentFiscalYear
+          - NextFiscalYear
+          - PreviousMonthToDate
+          - CurrentMonthToDate
+          - PreviousQuarterToDate
+          - CurrentQuarterToDate
+          - PreviousYearToDate
+          - CurrentYearToDate
+          - PreviousFiscalQuarterToDate
+          - CurrentFiscalQuarterToDate
+          - PreviousFiscalYearToDate
+          - CurrentFiscalYearToDate
+          - Values
+          - In
+          - NotIn
+        type: string
+        (amf-format): enum
+        required: true
+      value:
+        type: string
+        required: false
+      aggregationMethod:
+        enum:
+          - SEMANTIC_AGGREGATION_METHOD_UNSPECIFIED
+          - SEMANTIC_AGGREGATION_METHOD_NONE
+          - SEMANTIC_AGGREGATION_METHOD_AUTO
+          - SEMANTIC_AGGREGATION_METHOD_COUNT
+          - SEMANTIC_AGGREGATION_METHOD_SUM
+          - SEMANTIC_AGGREGATION_METHOD_AVG
+          - SEMANTIC_AGGREGATION_METHOD_MIN
+          - SEMANTIC_AGGREGATION_METHOD_MAX
+          - SEMANTIC_AGGREGATION_METHOD_MEDIAN
+          - SEMANTIC_AGGREGATION_METHOD_UNIQUE_COUNT
+          - SEMANTIC_AGGREGATION_METHOD_STDDEV
+          - SEMANTIC_AGGREGATION_METHOD_STDDEVP
+          - SEMANTIC_AGGREGATION_METHOD_VAR
+          - SEMANTIC_AGGREGATION_METHOD_VARP
+          - SEMANTIC_AGGREGATION_METHOD_USER_AGG
+        type: string
+        (amf-format): enum
+        required: false
+      fieldType:
+        enum:
+          - UNSPECIFIED
+          - FORMULA
+          - MODEL_FIELD
+        type: string
+        (amf-format): enum
+        required: false
+      values:
+        type: array
+        items:
+          type: string
+        required: false
+  Summary:
+    type: object
+    properties:
+      strategy:
+        description: Which summarization strategy was used
+        enum:
+          - SUMMARIZATION_STRATEGY_UNSPECIFIED
+          - SUMMARIZATION_STRATEGY_DIGEST
+        type: string
+        (amf-format): enum
+      markup:
+        description: Text for the summary
+        type: string
+      generationId:
+        description: ID of the Einstein GPT generation request.
+        type: string
+        required: false
+      timestamp:
+        description: Timestamp of the summary generation in UTC
+        type: string
+  Status:
+    type: object
+    properties:
+      qualifier:
+        description: Defines how the metric is tracking
+        enum:
+          - QUALIFIER_UNSPECIFIED
+          - QUALIFIER_HIGH
+          - QUALIFIER_LOW
+          - QUALIFIER_EXPECTED
+          - QUALIFIER_ON_TRACK
+          - QUALIFIER_OFF_TRACK
+          - QUALIFIER_ON_TRACK_TO_GOAL
+          - QUALIFIER_OFF_TRACK_TO_GOAL
+          - QUALIFIER_GOAL_CONDITION
+          - QUALIFIER_NO_STATUS
+        type: string
+        (amf-format): enum
+        required: false
+      sentiment:
+        description: |-
+          Represents a sentiment towards metric status.
+           Status sentiment is determined based on metric sentiment (e.g. up is good) and status qualifier
+        enum:
+          - SENTIMENT_UNSPECIFIED
+          - SENTIMENT_POSITIVE
+          - SENTIMENT_NEGATIVE
+          - SENTIMENT_NEUTRAL
+          - SENTIMENT_CUSTOM
+          - SENTIMENT_NO_SENTIMENT
+        type: string
+        (amf-format): enum
+        required: false
+  Measure:
+    type: object
+    properties:
+      field: FieldId
+      aggregation:
+        enum:
+          - AGGREGATION_UNSPECIFIED
+          - AGGREGATION_SUM
+          - AGGREGATION_AVERAGE
+          - AGGREGATION_MEDIAN
+          - AGGREGATION_MAX
+          - AGGREGATION_MIN
+          - AGGREGATION_COUNT
+          - AGGREGATION_COUNT_DISTINCT
+          - AGGREGATION_USER
+        type: string
+        (amf-format): enum
+        required: false
+title: TUA Insights API
+baseUri: api.salesforce.com
+(amf-serverDescription): Insights api
+description: Tableau Unified Analytics Insights Service providing insights about metrics
+version: v1
+(amf-tags):
+  - name: InsightsService
+
+/analytics/insights/v1:
+  /batches:
+    post:
+      displayName: generateInsightBatch
+      (amf-tags):
+        - InsightsService
+      body:
+        application/json:
+          type: GenerateInsightBatchRequest
+      headers:
+        'x-sfdc-sourceapp':
+          type: string
+          description: The viz or dashboard source template name - set to "platform" if the viz or dashboard does not have a source template
+          required: false
+        'x-sfdc-sourcecontext':
+          type: string
+          description: The context in which the request is being called from within the application
+          required: false
+      responses:
+        '200':
+          description: OK
+          body:
+            application/json:
+              type: GenerateInsightBatchResponse
+  /filterValues:
+    post:
+      displayName: filterValues
+      (amf-tags):
+        - InsightsService
+      body:
+        application/json:
+          type: GetFilterValuesRequest
+      headers:
+        'x-sfdc-sourceapp':
+          type: string
+          description: The viz or dashboard source template name - set to "platform" if the viz or dashboard does not have a source template
+          required: false
+        'x-sfdc-sourcecontext':
+          type: string
+          description: The context in which the request is being called from within the application
+          required: false
+      responses:
+        '200':
+          description: OK
+          body:
+            application/json:
+              type: GetFilterValuesResponse
+  /generateBundle:
+    post:
+      displayName: generateInsightBundle
+      (amf-tags):
+        - InsightsService
+      body:
+        application/json:
+          type: GenerateInsightBundleRequest
+      headers:
+        'x-sfdc-sourceapp':
+          type: string
+          description: The viz or dashboard source template name - set to "platform" if the viz or dashboard does not have a source template
+          required: false
+        'x-sfdc-sourcecontext':
+          type: string
+          description: The context in which the request is being called from within the application
+          required: false
+      responses:
+        '200':
+          description: OK
+          body:
+            application/json:
+              type: GenerateInsightBundleResponse
+  /basic/generateBundle:
+    post:
+      displayName: InsightsService_GenerateInsightBundleBase
+      description: Generate a basic bundle - returns Unusual Change and Period over Period Change Insights
+      (amf-tags):
+        - InsightsService
+      body:
+        application/json:
+          type: GenerateInsightBundleRequest
+      headers:
+        'x-sfdc-sourceapp':
+          type: string
+          description: The viz or dashboard source template name - set to "platform" if the viz or dashboard does not have a source template
+          required: false
+        'x-sfdc-sourcecontext':
+          type: string
+          description: The context in which the request is being called from within the application
+          required: false
+      responses:
+        '200':
+          description: OK
+          body:
+            application/json:
+              type: GenerateInsightBundleResponse
+  /batches/{batchId}:
+    get:
+      displayName: getInsightsBatch
+      (amf-tags):
+        - InsightsService
+      headers:
+        'x-sfdc-sourceapp':
+          type: string
+          description: The viz or dashboard source template name - set to "platform" if the viz or dashboard does not have a source template
+          required: false
+        'x-sfdc-sourcecontext':
+          type: string
+          description: The context in which the request is being called from within the application
+          required: false
+      responses:
+        '200':
+          description: OK
+          body:
+            application/json:
+              type: GetInsightBatchResponse