Newer Version Available

This content describes an older version of this product. View Latest

Analytics REST API Enums

Enums specific to the /wave namespace

Enums are not versioned. Enum Values are returned in all API versions. Clients should handle values they don't understand gracefully.

Enum Description
Auto​Install​Request​Failed​Reason​Enum The reason that the auto-install request failed, where applicable. Valid values are:
  • App​Construction​Failure
  • App​Create​Failure
  • App​Installation​Skipped
  • App​Update​Failure
  • Cancel​Failed
  • Delete​Failed
  • Dependency​Cancelled
  • Dependency​Failure
  • Failed​Other
  • Failed​To​Enqueue
  • Organization​Incompatible
  • Request​Cancelled
  • RetriesE​xhausted
  • Wave​Disabled
Auto​Install​Request​Search​Option​Enum Filters the results to include only the contents with specific search options. Valid values include:
  • Exclude​Non​Existing​Apps
  • Most​Recent​Only​By​Template​And​Folder
  • Non​Existing​Apps​Only
Auto​Install​Request​Sort​Option​Enum Sorts the results according to the given sort option. Valid values include:
  • Created​Date​Ascending
  • Created​Date​Descending
  • Folder​Id​Ascending
  • Folder​Id​Descending
  • Folder​Label​Ascending
  • Folder​Label​Descending
  • Last​Modified​Date​Ascending
  • Last​Modified​DateD​escending
  • Request​Name​Ascending
  • Request​Name​Descending
  • Request​Status​Ascending
  • Request​Status​Descending
  • Request​Type​Ascending
  • Request​Type​Descending
  • Template​Api​Name​Ascending
  • Template​Api​Name​Descending
Auto​Install​Request​Status​Enum The auto-install request status. Valid values include:
  • App​In​Progress
  • Cancelled
  • Enqueued
  • Failed
  • In​Progress
  • New
  • Skipped
  • Success
Auto​Install​Request​Type​Enum The type of the auto-install request. Valid values include:
  • Org​Compatibility​Check
  • Start​Dataflow
  • Wave​App​Auto​Update
  • Wave​App​Create
  • Wave​App​Delete
  • Wave​App​Update
  • Wave​Enable
Collection​Created​By​Type​Enum The type of user who created the pin. Valid values are:
  • Admin
  • None
  • User
Collection​Type​Enum The collection type. Valid values are: Static
Connect​Wave​Access​Type​Enum The access type. Valid values are:
  • Edit
  • Manage
  • View
Collection​Item​Asset​Type​Enum Filters the results by the collection item asset type. Valid values are:
  • Component
  • Dashboard
  • Dashboard​Saved​View
  • Lens
  • Lightning​Dashboard
  • Report
  • Tableau​Dashboard
  • Tableau​Workbook
Collection​Pin​Type​Enum The type of pinning. Valid values are:
  • All
  • Desktop
  • Mobile
  • None
Connect​Analytics​License​Type​Enum The Analytics license types. Valid values are:
  • Cdp (Data Cloud)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Sonic (Salesforce Data Pipeline)
Connect​Analytics​Limit​Type​Enum The types of limits used in Analytics. Valid values are:
  • Batch​Transformation​Hours (Maximum dataflow runtime per month)
  • Dataset​Queries (Maximum queries on datasets for all users)
  • Dataset​Row​Count (Maximum row of all datasets combined)
  • Max​Daily​Rows​Data​Cloud​Output​Con (Maximum rows for data cloud output per rolling 24-hour period)
  • Max​Daily​Rows​High​Output​Con (Maximum rows for all high volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Rows​Low​Output​Con (Maximum rows for all low volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Rows​Med​Output​Con (Maximum rows for all medium volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Size​High​Output​Con (Maximum data size for all high volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Size​Low​Output​Con (Maximum data size for all low volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Size​Med​Output​Con (Maximum data size for all medium volume tier output connectors per rolling 24-hour period)
  • Max​Daily​Size​Virtual​Private​Cloud​Con (Maximum cumulative bytes of data sent through connections using a virtual private cloud in a rolling 24-hour period)
  • Max​Daily​Upload​Volume (Maximum cumulative bytes of data files uploaded to Salesforce in a rolling 24-hour period)
  • Max​Daily​Workflow​Executions (Maximum number of dataflow and recipe runs in a rolling 24-hour period)
  • Max​Recipe​Out​Rows​Per​Month (Maximum number of rows output by all recipes to all datasets in a month)
  • Max​Replicated​Objects (Maximum number of connected objects)
  • Output​Local​Connector​Volume (Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period)
  • Staged​Dataset​Row​Count (Maximum rows for staged datasets)
Connect​Dashboard​Snapshot​Drift​State The drift state of the watchlist item. Valid values are:
  • Clean (Indicates the snapshot is clean)
  • Dirty (Indicates the snapshot has drifted and is dirty)
  • Ignore​Query​Drift (Indicates the snapshot is dirty, but user has ignored it)
Connect​Dashboard​Snapshot​Item​Last​Run​Status​Enum The status of the dashboard snapshot item run. Valid values are:
  • Dashboard​Bundle​Failed​To​Load
  • Failed​To​Parse​Value
  • Failed​To​Persist​Data
  • Generic​Exception
  • Query​Execution​Failed
  • Success
Connect​Eclair​Map​Projection​Type​Enum The map projection. Valid values are:
  • AlbersUSA
  • Equirectangular
  • Mercator
Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Connect​Job​Type​Enum The type of job. Valid values are:
  • Data​Cloud​Recipe
  • Data​Sync
  • File​Upload
  • Internal
  • Orchestrated
  • Recipe
  • Recipe_V3
  • Report
  • Restore
  • User
Connect​Schedule​Frequency​Type​Enum Frequency on which this schedule is run. Valid values are:
  • Daily (Run once per day)
  • Monthly (Run on one or more specific numeric days per month)
  • Monthly​Relative (Run on one or more relative days for month)
  • Weekly (Run on one or more days each week)
Connect​Subscription​Source​Type​Enum The type of subscription notification. Valid values are:
  • Collection
  • Dashboard
  • Widget
Connect​Wave​Application​Status​Enum The creation status of application. Valid values are:
  • Cancelled​Status
  • Completed​Status
  • Dataflow​In​Progress​Status
  • Extension​Asset​Type​In​Progress​Status
  • Failed​Status
  • In​Progress​Status
  • New​Status
Connect​Wave​Asset​Type​Enum The asset type. The default type is Dashboard. Valid types are:
  • Collection
  • Component
  • Contextual​Dashboard
  • Dashboard
  • Dashboard​Saved​View
  • Dashboard​Snapshot
  • Data​Cloud​Report
  • Data​Connector
  • Dataflow
  • Dataflow​Job
  • Dataflow​Job​Node
  • Dataset
  • Dataset​Shard
  • Dataset​Version
  • External​Data
  • Folder
  • Lens
  • Lightning​Component
  • Lightning​Dashboard
  • Lightning​Dashboard​Folder
  • Recipe
  • Recipe​Configuration
  • Recipe​Model
  • Replicated​Dataset
  • Report
  • Report​Folder
  • Story
  • Tableau​Dashboard
  • Tableau​Workbook
  • Template
  • Widget
  • Workflow
Connect​Wave​Asset​Visibility​Type Indicates whether the asset is hidden from users with view access or not. Valid values are:
  • All (Show all assets)
  • Limited (Hide assets from viewers with view access)
Connect​Wave​Border​Edge​Type​Enum The edges of the border to be drawn. Valid values are:
  • All
  • Bottom
  • Left
  • Right
  • Top
Connect​Wave​Compact​Form​Cogroup​Type​Enum The compact form source cogroup type. Valid values are:
  • Full
  • Inner
  • Left
  • Right
Connect​Wave​Compact​Form​Join​Type​Enum The compact form join type. Valid values are:
  • Inner
  • Left
  • Outer
  • Right
Connect​Wave​Conditional​Formatting​Type​Enum The conditional formatting type. Valid values are:
  • Categories
  • Gradient
  • Multiple
  • Raw
  • Single
  • Static
Connect​Wave​Connection​Mode​Enum The connection mode for data sync. For faster extracts, use Incremental or PeriodicFull. Valid values are:
  • Full
  • Incremental
  • Periodic​Full
Connect​Wave​Dashboard​Saved​View​Type The type of saved view.���
  • Shared
  • User
Connect​Wave​Dashboard​Saved​View​Dataset​State​Type The type of dataset state. Valid values are:
  • Global
Connect​Wave​Data​Connector​Bundle​Enum The bundle type that the data connector belongs to. Valid values are:
  • AmazonRedshift
  • AmazonS3
  • Azure
  • Cdp
  • Salesforce
  • Snowflake
  • Tableau
Connect​Wave​Connector​Category​Enum The categories that the data connector belongs to. Valid values are:
  • Advanced​Properties​Support
  • Batch​Read
  • Direct
  • File​Based
  • Filter​Support
  • Output
  • Private
Connect​Wave​Dashboard​Step​Type​Enum The type of dashboard step. Valid values are:
  • Aggregate
  • Aggregate​Flex
  • Apex
  • Cdp
  • Direct​Report
  • Discovery
  • Forecasting
  • Grain
  • Hierarchy
  • Lens
  • Multi
  • Saql
  • Soql
  • Sql
  • Static
  • Static​Flex
  • Watchlist
Connect​Wave​Data​Connector​Handler​Enum The connector handler associated with the Analytics connector. Valid values are:
  • Base
  • Legacy
Connect​Wave​Data​Connector​Type​Enum The type of Analytics connector. The valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Connect​Wave​Dataflow​Job​Status​Enum The status of the dataflow job. Valid values are:
  • Cancelled
  • Failure
  • Preprocessing
  • Queued
  • Running
  • Success
  • Warning
Connect​Wave​Dataset​Type​Enum The type of the dataset. Valid values are:
  • Default
  • Live
  • Staged​Data
  • Trended
Connect​Wave​Data​Source​Type​Enum The type of datasource. Valid values are:
  • Apex
  • Cdp
  • Dataset
  • Hierarchy
  • Report​Type
  • Saql
  • Sobject
  • Static
Connect​Wave​Date​Type The Date type. Valid values are:
  • Date
  • DateOnly
  • DateTime
Connect​Wave​Horizontal​Alignment​Enum The horizontal alignment types. Valid values are:
  • Center
  • Left
  • Right
Connect​Wave​Image​Fit​Type​Enum The image alignment types. Valid values are:
  • FitHeight
  • FitWidth
  • Original
  • Stretch
  • Tile
Connect​Wave​Input​Widget​Display​Format​Enum The display format of the input value. Valid values are:
  • Currency
  • None
  • Percent
Connect​Wave​Input​Widget​Input​Type​Enum The input type of the widget. Valid values are:
  • Slider
  • Typein
Connect​Wave​Input​Widget​Value​Format​Enum The value type of the step. Valid values are:
  • Date
  • Number
  • Text
Connect​Wave​Interaction​Action​Type​Enum The action type for the interaction. Valid values are:
  • Clear
  • Flow
  • Navigate
  • Reset
  • Sort
Connect​Wave​Interaction​Clear​Type​Enum The type for the clear interaction. Valid values are:
  • Clear​All
  • Clear​Exclude
  • Clear​Include
Connect​Wave​Interaction​Destination​Type​Enum The destination type for the interaction. Valid values are:
  • Component
  • Dashboard
  • Explore
  • Lens
  • Page
  • Url
Connect​Wave​Interaction​Event​Type​Enum The event type for the interaction. Valid values are:
  • Click
  • Select
Connect​Wave​Interaction​Reset​Type​Enum The reset type for the interaction. Valid values are:
  • Reset​Filters
Connect​Wave​Language​Enum The language in which this Xmd is localized. Valid values are:
  • bg: Bulgarian
  • zh_CN: Chinese ​Simplified
  • zh_TW: Chinese ​Traditional
  • hr: Croatian
  • cs: Czech
  • da: Danish
  • nl_NL: Dutch
  • en: English
  • en_GB: English ​(United Kingdom)
  • fi: Finnish
  • fr: French
  • de: German
  • el: Greek
  • hu: Hungarian
  • in: Indonesian
  • it: Italian
  • ja: Japanese
  • ko: Korean
  • no: Norwegian
  • pl: Polish
  • pt_PT: Portuguese ​(Portugal)
  • pt_BR: Portuguese ​(Brazil)
  • ro: Romanian
  • ru: Russian
  • sk: Slovak
  • sl: Slovenian
  • es: Spanish
  • es_MX: Spanish ​(Mexico)
  • sv: Swedish
  • th: Thai
  • tr: Turkish
  • uk: Ukrainian
  • vi: Vietnamese
Connect​Wave​Select​Mode​Enum The select mode types. Valid values are:
  • Multi
  • MultiRequired
  • None
  • Single
  • SingleRequired
Connect​Wave​Vertical​Alignment​Enum The vertical alignment types. Valid values are:
  • Bottom
  • Center
  • Top
Connect​Wave​Visualization​Type​Enum The visualization type for a lens. Valid values are:
  • Bullet
  • Calendar​Heat​Map
  • Combo
  • Comparison​Table
  • Flatgauge
  • Gauge
  • Heat​Map
  • Horizontal​Bar
  • Horizontal​Dot
  • Line
  • Matrix
  • Parallel​Coordinates
  • Pie
  • Pivot​Table
  • Polargauge
  • Pyramid
  • Rating
  • Scatter
  • Stack​Waterfall
  • Stacked​Horizontal​Bar
  • Stacked​Vertical​Bar
  • Time
  • Time​Bar
  • Time​Combo
  • Values​Table
  • Vertical​Bar
  • Vertical​Dot
  • Waterfall
Connect​Wave​Schedule​Frequency​Type​Enum Frequency on which this schedule is run. Valid values are:
  • Daily (Run once per day)
  • Event​Driven (Create Event Driven schedule)
  • Hourly (Run on one or more hours each day)
  • Minutely (Run subhourly each day)
  • Monthly (Run on one or more specific numeric days per month)
  • Monthly​Relative (Run on one or more relative days for month)
  • None (Not scheduled to run)
  • Weekly (Run on one or more days each week)
Connect​Wave​Day​Of​Week​Enum Days of the week on which the schedule runs. Valid values are:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Connect​Wave​Selector​Display​Mode​Enum The display mode type. Valid values are:
  • Combo
  • Filter
Connect​Wave​Relative​Week​Enum Week within a month. Values values are:
  • First
  • Second
  • Third
  • Fourth
  • Last
Connect​Wave​Share​Type​Enum The share type. Valid values are:
  • All​Csp​Users
  • All​Prm​Users
  • Customer​Portal​User
  • Group
  • Organization
  • Partner​User
  • PortalRole
  • Portal​Role​And​Subordinates
  • Role
  • Role​And​Subordinates
  • Role​And​Subordinates​Internal
  • User
Connect​Wave​Template​App​Action​Enum The last template action performed on the templated application. Valid values are:
  • Auto​Upgrade
  • Create
  • Decouple​App
  • Overlay
  • Refresh​Data
  • Upgrade
Connect​Wave​Template​Type​Enum The template type. Valid values are:
  • App
  • Dashboard
  • Data
  • Embedded
  • Lens
Connect​Wave​Template​Visibility​Options​Enum The template visibility options. Valid values are:
  • Create​App
  • Manageable​Only
  • Org​Can​View​Only
  • View​Only
Connect​Wave​Text​Overflow​Enum The overflow of the text. Valid values are:
  • Truncate
  • Wrap
Connect​Wave​Widget​Type​Enum The type of widget. Values are:
  • Box
  • Chart
  • Compare​Table
  • Component"
  • Container
  • Date​Selector
  • Filter​Panel
  • Global​Filters
  • Image
  • Inherit
  • Input
  • Link
  • List​Selector
  • Navigation
  • Number
  • Pill​Box
  • Range​Selector
  • Repeater
  • Table
  • Text
  • Url
  • Values​Table
Connect​Wave​Xmd​Type​Enum The type of Xmd. Values are:
  • asset
  • main
  • system
  • user
Custom​Filter​Preset​Type​Enum The custom preset filter types. Valid values are:
  • All​Time
  • Current​Fiscal​Quarter
  • Current​Fiscal​Quarter​To​Date
  • Current​Fiscal​Year
  • Current​Fiscal​Year​To​Date
  • Current​Month
  • Current​Month​To​Date
  • Current​Quarter
  • Current​Quarter​To​Date
  • Current​Week
  • Current​Year
  • Current​Year​To​Date
  • Last​180​Days
  • Last​30​Days
  • Last​7​Days
  • Last​90​Days
  • Next​180​Days
  • Next​30​Days
  • Next​7​Days
  • Next​90​Days
  • Next​Fiscal​Quarter
  • Next​Fiscal​Year
  • Next​Month
  • Next​Quarter
  • Next​Week
  • Next​Year
  • Previous​Fiscal​Quarter
  • Previous​Fiscal​Quarter​To​Date
  • Previous​Fiscal​Year
  • Previous​Fiscal​Year​To​Date
  • Previous​Fiscal​Month
  • Previous​Fiscal​Month​To​Date
  • Previous​Quarter
  • Previous​Quarter​To​Date
  • Previous​Week
  • Previous​Year
  • Previous​Year​To​Date
Data​Platform​Audit​Type​Enum The type of audit event. Valid values are:
  • Job​Cancelled (Job was canceled by a user)
  • Job​Run​Event​Based (Job was run on an event-based schedule)
  • Job​Run​Manual (Job was run manually)
  • Job​Run​Time​Based (Job was run on an time-based schedule)
  • Job​Schedule​Modified (Job schedule was modified)
  • Job​Scheduled (Job was scheduled)
  • Job​Unscheduled (Job was unscheduled)
Dataset​Dmo​Mapping​App​Status​Enum The app status the mappings are associated with. Values are:
  • Idle
  • In​Progress
  • Undefined
Map<Object,Object> The map of dynamic options for Analytics apps. Valid options are:
  • production​Type: valid values include
    • ATF_3_0
    • Classic
  • runtime​Log​Entry​Level: valid values include
    • Fine
    • Finer
    • Finest
    • Info
    • Severe
    • Warning
Hierarchy​Type​Enum The type of hierarchy used to facet. Valid values are:
  • Forecast​Hierarchy
  • Role​Hierarchy
Layout​Type​Enum The layout type. Valid values are:
  • Component
  • Single​Column
  • Two​Column
Notification​Action​Type The notification action type. Valid values are:
  • Post​To​Slack
  • Send​Email
Number​Type​Format​Enum The format for a template variable number type. Valid values are:
  • Currency
  • Decimal
  • Percent
  • Percent​Fixed
Page​Type​Enum The template wizard page type. Values are:
  • Configuration
  • Validation
Panel​Item​Type​Enum The template wizard panel item type. Valid values are:
  • Group​Box
  • Image
  • Link​Box
  • Text
  • Variable
Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Subscription​Schedule​Day​Of​Week The days of the week for schedule frequency. Valid values are:
  • Fri
  • Mon
  • Sat
  • Sun
  • Thu
  • Tue
  • Wed
Tooltip​Mode​Enum The tooltip mode. Valid values are:
  • Custom
  • Default
  • None
Template​Readiness​Status​Enum The status of the readiness task. Valid values are:
  • Complete
  • Failed
  • Warning
Variable​Type​Enum The type of the template variable. Valid values are:
  • Array​Type
  • Boolean​Type
  • Calculated​Insight​Field​Type
  • Calculated​Insight​Type
  • Connector​Type
  • Data​Lake​Object​Field​Type
  • Data​Lake​Object​Type
  • Data​Model​Object​Field​Type
  • Data​Model​Object​Type
  • Dataset​Any​Field​Type
  • Dataset​Date​Type
  • Dataset​Dimension​Type
  • Dataset​Measure​Type
  • Dataset​Type
  • Date​Time​Type
  • Number​Type
  • Object​Type
  • Sobject​Field​Type
  • Sobject​Type
  • String​Type
Property Name Enum Description Required or Optional Available Version
sort Connect​Wave​Dataset​Sort​Order​Type​Enum The type of sort order to be applied to the returned dataset collection. Valid values are:
  • Connection​Name (only valid if the dataset is a Live Dataset)
  • Created​By
  • Created​Date
  • Last​Modified
  • Last​Queried
  • Last​Refreshed
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Total​Rows
Optional 38.0
scope Connect​Wave​Scope​Type​Enum The type of scope to be applied to the returned collection. Valid values are:
  • Browse
  • Created​By​Me
  • Insights​Applications​Is​Cans​Edit
  • Mru (Most Recently Used)
  • Shared​With​Me
Optional 38.0
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Owner
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
Optional 38.0
template​Filters Connect​Wave​Template​Search​Filters​Enum The filter templates to apply to the returned collection. Valid values are:
  • Apps​Constructed​By​Template
  • Apps​With​Install​History
Optional 57.0