salesforcer: sf_dashboard_status – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

sf_dashboard_status

Get the status of a dashboard

sf_dashboard_status(
  dashboard_id,
  running_user = NULL,
  dashboard_filters = c(character(0))
)

`dashboard_id`	`character`; the Salesforce Id assigned to a created dashboard. It will start with `"01Z"`.
`running_user`	`character`; the Salesforce Id that should be assigned as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not allowed to change the running User, or if the selected running User is invalid.
`dashboard_filters`	`character`; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids from the dashboard metadata using sf_dashboard_describe.

list

An Implementation of 'Salesforce' APIs Using Tidy Principles

v0.2.2

MIT + file LICENSE

Authors

Steven M. Mortimer [aut, cre], Takekatsu Hiramura [ctb], Jennifer Bryan [ctb, cph], Joanna Zhao [ctb, cph]

Initial release

2020-09-07