sf_describe_dashboard: Describe a dashboard

In salesforcer: An Implementation of 'Salesforce' APIs Using Tidy Principles

Describe a dashboard

Description

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

Usage

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

Arguments

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.

Value

list or tbl_df depending on the value of argument as_tbl

See Also

• Salesforce Documentation

• Salesforce Example

salesforcer documentation built on March 18, 2022, 6:26 p.m.