Salesforce Analytics Plugin CLI Command Reference

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Analytics CLI Plugin Command Reference
sf
sfdx (Deprecated)
analytics:enable (Deprecated)
analytics:query (Deprecated)
app Commands (Deprecated)
asset Commands (Deprecated)
autoinstall Commands (Deprecated)
analytics:autoinstall:app:cancel (Deprecated)
analytics:autoinstall:app:create (Deprecated)
analytics:autoinstall:app:delete (Deprecated)
analytics:autoinstall:app:update (Deprecated)
analytics:autoinstall:display (Deprecated)
analytics:autoinstall:list (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
PDF

autoinstall Commands (Deprecated)

Manage Analytics auto-install requests.

analytics:autoinstall:app:cancel (Deprecated)

Cancels an auto-install request for an Analytics app.

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:autoinstall:app:cancel 

sfdx analytics:autoinstall:app:cancel -i id

Command Syntax

sfdx analytics:autoinstall:app:cancel
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i AUTOINSTALLID

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 | --autoinstallid AUTOINSTALLID
Required

ID of the auto-install request to cancel.

Type: id

analytics:autoinstall:app:create (Deprecated)

Creates auto-install request to create an Analytics app.

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:autoinstall:app:create 

sfdx analytics:autoinstall:app:create -t templateid
sfdx analytics:autoinstall:app:create -n templatename

Command Syntax

sfdx analytics:autoinstall:app:create
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-t TEMPLATEID]
[-n TEMPLATENAME]
[-a]
[-w WAIT]
[-p POLLINTERVAL]

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
-t | --templateid TEMPLATEID
Optional

The ID of the Analytics template.

Type: id
-n | --templatename TEMPLATENAME
Optional

The API name of the Analytics template.

Type: string
-a | --async
Optional

Create app asynchronously.

Type: boolean
-w | --wait WAIT
Optional

Wait time in minutes for auto-install request to finish (default 10).

Type: number
Default value: 10
-p | --pollinterval POLLINTERVAL
Optional

Polling interval in milliseconds for checking auto-install request status (default 5000).

Type: number
Default value: 5000

analytics:autoinstall:app:delete (Deprecated)

Creates auto-install request to delete an Analytics app.

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:autoinstall:app:delete 

sfdx analytics:autoinstall:app:delete -f folderid

Command Syntax

sfdx analytics:autoinstall:app:delete
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-f FOLDERID
[-a]
[-w WAIT]
[-p POLLINTERVAL]

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
-f | --folderid FOLDERID
Required

ID of the folder that contains the app data.

Type: id
-a | --async
Optional

Delete app asynchronously.

Type: boolean
-w | --wait WAIT
Optional

Wait time in minutes for auto-install request to finish (default 10).

Type: number
Default value: 10
-p | --pollinterval POLLINTERVAL
Optional

Polling interval in milliseconds for checking auto-install request status (default 5000).

Type: number
Default value: 5000

analytics:autoinstall:app:update (Deprecated)

Creates auto-install request to update an Analytics app.

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:autoinstall:app:update 

sfdx analytics:autoinstall:app:update -t templateid -f folderid
sfdx analytics:autoinstall:app:update -n templatename -f folderid

Command Syntax

sfdx analytics:autoinstall:app:update
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-t TEMPLATEID]
[-n TEMPLATENAME]
-f FOLDERID
[-a]
[-w WAIT]
[-p POLLINTERVAL]

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
-t | --templateid TEMPLATEID
Optional

The ID of the Analytics template.

Type: id
-n | --templatename TEMPLATENAME
Optional

The API name of the Analytics template.

Type: string
-f | --folderid FOLDERID
Required

ID of the folder that contains the app data.

Type: id
-a | --async
Optional

Update app asynchronously.

Type: boolean
-w | --wait WAIT
Optional

Wait time in minutes for auto-install request to finish (default 10).

Type: number
Default value: 10
-p | --pollinterval POLLINTERVAL
Optional

Polling interval in milliseconds for checking auto-install request status (default 5000).

Type: number
Default value: 5000

analytics:autoinstall:display (Deprecated)

Displays an Analytics auto-install request details.

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:autoinstall:display 

sfdx analytics:autoinstall:display -i id

Command Syntax

sfdx analytics:autoinstall:display
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i AUTOINSTALLID
[-a]

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 | --autoinstallid AUTOINSTALLID
Required

ID of the auto-install request.

Type: id
-a | --applog
Optional

Specify to include app creation log details.

Type: boolean

analytics:autoinstall:list (Deprecated)

Lists Analytics auto-install requests 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:autoinstall:list 

sfdx analytics:autoinstall:list

Command Syntax

sfdx analytics:autoinstall: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