@salesforce/lds-adapters-sfap-analytics-insights 1.298.0

package/src/raml/api.raml

@@ -0,0 +1,723 @@
+#%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: Insight
+      error:
+        type: Error
+        required: false
+      insightType:
+        type: string
+        required: false
+  SemanticField:
+    type: object
+    properties:
+      name:
+        description: The apiName of the semanticField
+        type: string
+        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: object
+        required: false
+      facts:
+        type: object
+        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
+      vegaLiteViz:
+        description: vegaLiteViz will be removed in the future
+        type: object
+        required: false
+  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:
+        type: array
+        items: Filter
+        required: false
+      runningTotal:
+        type: boolean
+        required: false
+  MeasurementPeriod:
+    type: object
+    properties:
+      granularity:
+        description: The amount of time to aggregate to
+        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:
+        description: The period to count as the current one
+        enum:
+          - RANGE_UNSPECIFIED
+          - RANGE_CURRENT_PARTIAL
+          - RANGE_LAST_COMPLETE
+          - RANGE_CUSTOM
+        type: string
+        (amf-format): enum
+        required: false
+      start:
+        description: |-
+          (Inclusive) Start
+           Ignored (and computed server side) unless range = RANGE_CUSTOM, in which case it is required
+           When specified, formatted as date only ("2006-01-02")
+        type: string
+        required: false
+      end:
+        description: |-
+          (Inclusive) End
+           Ignored (and computed server side) unless range = RANGE_CUSTOM, in which case it is required
+           When specified, formatted as date only ("2006-01-02")
+        type: string
+        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
+        (amf-and):
+          - SummaryResponse
+        type: any
+        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: MeasurementPeriod
+      filters:
+        type: array
+        items: Filter
+        required: false
+  BatchInput:
+    type: object
+    properties:
+      bundleInput:
+        type: InsightBundleInput
+        required: false
+      metricInstanceId:
+        type: string
+        required: false
+  OverviewResponse:
+    type: object
+    properties:
+      result: Overview
+      error:
+        type: Error
+        required: false
+  InputMetric:
+    type: object
+    properties:
+      metric: MetricDefinition
+      instance: MetricInstance
+      extensionOptions: ExtensionOptions
+      representationOptions: RepresentationOptions
+      insightsOptions: InsightsOptions
+  TimeDimension:
+    type: object
+    properties:
+      tableField: TableField
+      semanticField: SemanticField
+  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
+        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
+        (amf-and):
+          - InsightBundleInput
+        type: any
+        required: false
+      options:
+        description: Options affecting the generation of the bundle
+        (amf-and):
+          - InsightBundleOptions
+        type: any
+        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
+        (amf-and):
+          - InsightBundle
+        type: any
+        required: false
+      error:
+        type: Error
+        required: false
+      id:
+        description: id of the bundle response, for cacheing
+        type: string
+        required: true
+  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
+  TableField:
+    type: object
+    properties:
+      name:
+        description: The apiName of the field
+        type: string
+        required: false
+      tableName:
+        description: The apiName of the table the field is on
+        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
+  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:
+      bundles:
+        description: ID of the batch being generated
+        type: array
+        items: InsightBundle
+        required: false
+      hasErrors:
+        description: Flag denoting if any insights encountered errors during generation
+        type: boolean
+        required: false
+      summary:
+        description: Summary generated by GAI
+        (amf-and):
+          - SummaryResponse
+        type: any
+        required: false
+      batchId:
+        description: Batch id
+        type: string
+        required: true
+  Overview:
+    type: object
+    properties:
+      viz:
+        type: object
+        required: false
+      vegaLiteViz:
+        description: Vega-lite spec giving a summary viz
+        type: object
+        required: false
+  GetFilterValuesResponse:
+    type: object
+    properties:
+      categoricalValues: GetFilterValuesResponse_CategoricalValues
+      nextPageToken:
+        type: string
+        required: false
+      totalAvailable:
+        type: number
+        format: int32
+        required: false
+      id:
+        type: string
+        required: true
+  NullableValue:
+    type: object
+    properties:
+      nullValue:
+        enum:
+          - NULL_VALUE
+        type: string
+        (amf-format): enum
+        required: false
+      string:
+        type: string
+        required: false
+      boolean:
+        type: boolean
+        required: false
+      number:
+        type: number
+        format: float
+        required: false
+      date:
+        description: Dates should be passed in as string_value and formatted as RFC3339 ("2006-01-02T15:04:05Z07:00")
+        type: string
+        required: false
+  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
+        (amf-and):
+          - InsightBundleOptions
+        type: any
+        required: false
+      summarization:
+        description: Options to apply to desired summary
+        (amf-and):
+          - SummarizationOptions
+        type: any
+        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
+        (amf-and):
+          - BatchOptions
+        type: any
+        required: false
+  Filter:
+    type: object
+    properties:
+      operator:
+        enum:
+          - OPERATOR_UNSPECIFIED
+          - OPERATOR_IN
+          - OPERATOR_NOT_IN
+          - OPERATOR_EQUALS
+          - OPERATOR_DOES_NOT_EQUAL
+          - OPERATOR_LESS_THAN
+          - OPERATOR_LESS_THAN_OR_EQUAL_TO
+          - OPERATOR_GREATER_THAN
+          - OPERATOR_GREATER_THAN_OR_EQUAL_TO
+          - OPERATOR_BETWEEN
+          - OPERATOR_CONTAINS
+          - OPERATOR_CONTAINS_IGNORE_CASE
+          - OPERATOR_NOT_CONTAINS
+          - OPERATOR_NOT_CONTAINS_IGNORE_CASE
+          - OPERATOR_STARTS_WITH
+          - OPERATOR_STARTS_WITH_IGNORE_CASE
+          - OPERATOR_DOES_NOT_START_WITH
+          - OPERATOR_DOES_NOT_START_WITH_IGNORE_CASE
+          - OPERATOR_ENDS_WITH
+          - OPERATOR_ENDS_WITH_IGNORE_CASE
+          - OPERATOR_DOES_NOT_END_WITH
+          - OPERATOR_DOES_NOT_END_WITH_IGNORE_CASE
+          - OPERATOR_LIKE
+        type: string
+        (amf-format): enum
+        required: false
+      tableField: TableField
+      semanticField: SemanticField
+      values:
+        type: array
+        items: NullableValue
+        required: false
+  GetFilterValuesRequest:
+    type: object
+    properties:
+      semanticDataModel: SemanticDataModel
+      tableField:
+        type: TableField
+        required: false
+      semanticField:
+        type: SemanticField
+        required: false
+      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
+  Summary:
+    type: object
+    properties:
+      strategy:
+        description: Which summarization strategy was used
+        enum:
+          - SUMMARIZATION_STRATEGY_UNSPECIFIED
+          - SUMMARIZATION_STRATEGY_DIGEST
+        type: string
+        (amf-format): enum
+        required: false
+      markup:
+        description: Text for the summary
+        type: string
+        required: false
+      generationId:
+        description: ID of the Einstein GPT generation request.
+        type: string
+        required: false
+      timestamp:
+        description: Timestamp of the summary generation in UTC
+        type: string
+        required: false
+  Measure:
+    type: object
+    properties:
+      tableField: TableField
+      semanticField: SemanticField
+      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: https://api.salesforce.com/analytics/insights/{version}
+(amf-serverDescription): Insights api
+description: Tableau Unified Analytics Insights Service providing insights about metrics
+version: v1-alpha.3
+(amf-tags):
+  - name: InsightsService
+/batches:
+  post:
+    displayName: generateInsightBatch
+    (amf-tags):
+      - InsightsService
+    body:
+      application/json: GenerateInsightBatchRequest
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json: GenerateInsightBatchResponse
+/filterValues:
+  post:
+    displayName: filterValues
+    (amf-tags):
+      - InsightsService
+    body:
+      application/json: GetFilterValuesRequest
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json: GetFilterValuesResponse
+/batches/{batch_id}:
+  get:
+    displayName: getInsightBatch
+    (amf-tags):
+      - InsightsService
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json: GetInsightBatchResponse
+/v1/generateBundle:
+  post:
+    displayName: generateInsightBundle
+    (amf-tags):
+      - InsightsService
+    body:
+      application/json: GenerateInsightBundleRequest
+    responses:
+      '200':
+        description: OK
+        body:
+          application/json: GenerateInsightBundleResponse