@salesforce/analytics
commands for working with analytics applications
Last updated 4 months ago by jgrantham .
BSD-3-Clause · Original npm · Tarball · package.json
$ cnpm install @salesforce/analytics 
SYNC missed versions from official npm registry.

@salesforce/analytics

commands for working with analytics applications

Install

$ sfdx plugins:install @salesforce/analytics

Usage

$ sfdx analytics --help [COMMAND]
...

sfdx analytics:app:create [-t <string>] [-f <filepath>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

create an analytics application

USAGE
  $ sfdx analytics:app:create [-t <string>] [-f <filepath>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --definitionfile=definitionfile             analytics template definition file; required unless --templateid is
                                                  specified

  -t, --templateid=templateid                     template ID; required unless --definitionfile is specified

  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org

  --apiversion=apiversion                         override the api version used for api requests made by this command

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLES
  $ sfdx analytics:app:create -t templateid
  $ sfdx analytics:app:create -f path_to_json_file

sfdx analytics:app:delete -f <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

delete analytics applications

USAGE
  $ sfdx analytics:app:delete -f <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --folderid=folderid                         (required) folder ID
  -p, --noprompt                                  do not prompt to confirm force delete
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:app:delete -f folderid

sfdx analytics:app:list [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list analytics applications

USAGE
  $ sfdx analytics:app:list [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --folderid=folderid                         folder ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:app:list --targetusername myOrg@example.com

sfdx analytics:app:update -f <filepath> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

updates an analytics application

USAGE
  $ sfdx analytics:app:update -f <filepath> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --definitionfile=definitionfile             (required) analytics application definition file for updates
  -i, --folderid=folderid                         (required) folder ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:app:update -i folderId -f path_to_json_file

sfdx analytics:dashboard:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list history records for analytics dashboards

USAGE
  $ sfdx analytics:dashboard:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -i, --dashboardid=dashboardid                   (required) dashboard ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:history:list --dashboardid <dashboardid>

sfdx analytics:dashboard:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

revert to specified history record

USAGE
  $ sfdx analytics:dashboard:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -h, --historyid=historyid                       (required) dashboard history ID
  -i, --dashboardid=dashboardid                   (required) dashboard ID
  -l, --label=label                               label for new reverted history record
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:history:revert -d <dashboardid> -h <historyid> -l <historyLabel>

sfdx analytics:dashboard:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list analytics dashboards

USAGE
  $ sfdx analytics:dashboard:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:list --targetusername myorg@example.com --targetdevhubusername devhub@example.com

sfdx analytics:dataflow:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list history records for analytics dataflows

USAGE
  $ sfdx analytics:dataflow:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -i, --dataflowid=dataflowid                     (required) dataflow ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:history:list --dataflowid <dataflowid>

sfdx analytics:dataflow:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

revert to specified history record

USAGE
  $ sfdx analytics:dataflow:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -h, --historyid=historyid                       (required) dataflow history ID
  -i, --dataflowid=dataflowid                     (required) dataflow ID
  -l, --label=label                               label for new reverted history record
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:history:revert -d <dataflowid> -h <historyid> -l <historyLabel>

sfdx analytics:dataflow:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list analytics dataflows

USAGE
  $ sfdx analytics:dataflow:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:list --targetusername myorg@example.com

sfdx analytics:lens:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list history records for analytics lens

USAGE
  $ sfdx analytics:lens:history:list -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -i, --lensid=lensid                             (required) lens ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:lens:history:list --lensid <lensid>

sfdx analytics:lens:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

revert to specified history record

USAGE
  $ sfdx analytics:lens:history:revert -i <string> -h <string> [-l <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -h, --historyid=historyid                       (required) dashboard history ID
  -i, --lensid=lensid                             (required) dashboard ID
  -l, --label=label                               label for new reverted history record
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:history:revert -d <dashboardid> -h <historyid> -l <historyLabel>

sfdx analytics:lens:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list analytics lenses

USAGE
  $ sfdx analytics:lens:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:lens:list --targetusername myorg@example.com

sfdx analytics:template:create -f <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

create analytics templates

USAGE
  $ sfdx analytics:template:create -f <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --folderid=folderid                         (required) folder ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:template:create -f folderid

sfdx analytics:template:delete -t <id> [--forcedelete] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

delete analytics templates

USAGE
  $ sfdx analytics:template:delete -t <id> [--forcedelete] [-p] [-u <string>] [--apiversion <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --noprompt                                  do not prompt to confirm force delete
  -t, --templateid=templateid                     (required) template ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command

  --forcedelete                                   force delete the analytics template and all linked analytics
                                                  applications

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:template:delete -t templateid

sfdx analytics:template:list [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list analytics templates

USAGE
  $ sfdx analytics:template:list [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -a, --includesalesforcetemplates                include salesforce templates
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:template:list --targetusername myorg@example.com --targetdevhubusername devhub@example.com

sfdx analytics:template:update -t <id> [-f <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

update analytics templates

USAGE
  $ sfdx analytics:template:update -t <id> [-f <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -f, --folderid=folderid                         folder ID
  -t, --templateid=templateid                     (required) template ID
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx analytics:template:update -t templateid -f folderid

Current Tags

  • 0.6.0                                ...           latest (4 months ago)

6 Versions

  • 0.6.0                                ...           4 months ago
  • 0.5.0                                ...           4 months ago
  • 0.4.0                                ...           8 months ago
  • 0.3.0                                ...           9 months ago
  • 0.2.0                                ...           10 months ago
  • 0.1.0                                ...           a year ago

Copyright 2014 - 2016 © taobao.org |