salesforcer: sf_dashboard_describe – R documentation

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

sf_dashboard_describe

Describe a dashboard

Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.

sf_dashboard_describe(dashboard_id, as_tbl = TRUE, verbose = FALSE)

`dashboard_id`	`character`; the Salesforce Id assigned to a created dashboard. It will start with `"01Z"`.
`as_tbl`	`logical`; an indicator of whether to convert the parsed JSON into a `tbl_df`.
`verbose`	`logical`; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to `TRUE` the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

list or tbl_df depending on the value of argument as_tbl