dashboard Commands (Deprecated)

Manage Analytics dashboards.

analytics:dashboard:history:list (Deprecated) 

Lists history records for Analytics dashboards in the specified target org.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:dashboard:history:list 

 
1sfdx analytics:dashboard:history:list --dashboardid <dashboardid>

Command Syntax 
sfdx analytics:dashboard:history:list

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

-i DASHBOARDID

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-i | --dashboardid DASHBOARDID

Required

The ID of the dashboard to show history records.

Type: id

analytics:dashboard:history:revert (Deprecated) 

Revert to a specified history record.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:dashboard:history:revert 

 
1sfdx analytics:dashboard:history:revert -i <dashboardid> -y <historyid> -l <historyLabel>

Command Syntax 
sfdx analytics:dashboard:history:revert

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

-i DASHBOARDID

-y HISTORYID

[-l LABEL]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-i | --dashboardid DASHBOARDID

Required

The ID of the dashboard to show history records.

Type: id

-y | --historyid HISTORYID

Required

The ID of the dashboard history records.

Type: id

-l | --label LABEL

Optional

Label for new reverted history record.

Type: string

analytics:dashboard:list (Deprecated) 

Lists Analytics dashboards in the specified target org.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:dashboard:list 

 
1sfdx analytics:dashboard:list

Command Syntax 
sfdx analytics:dashboard:list

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

analytics:dashboard:update (Deprecated) 

Updates an Analytics dashboard.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:dashboard:update 

 
1sfdx analytics:dashboard:update -i dashboardId -y currentHistoryId
1sfdx analytics:dashboard:update -i dashboardId -r

Command Syntax 
sfdx analytics:dashboard:update

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

-i DASHBOARDID

[-y CURRENTHISTORYID]

[-r]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-i | --dashboardid DASHBOARDID

Required

Dashboard ID.

Type: id

-y | --currenthistoryid CURRENTHISTORYID

Optional

Current History ID to display.

Type: id

-r | --removecurrenthistory

Optional

Remove Current History ID from dashboard.

Type: boolean

Salesforce Analytics CLI Plugin Command Reference
sf
sfdx (Deprecated)
analytics:enable (Deprecated)
analytics:query (Deprecated)
app Commands (Deprecated)
asset Commands (Deprecated)
autoinstall Commands (Deprecated)
dashboard Commands (Deprecated)
dataflow Commands (Deprecated)
dataset Commands (Deprecated)
generate Commands (Deprecated)
lens Commands (Deprecated)
recipe Commands (Deprecated)
template Commands (Deprecated)
Help for Salesforce CLI Commands
CLI Deprecation Policy
Previous Versions