sf_list_reports: List reports

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

List reports

Description

Displays a list of full list of reports based on the Report object. If recent is up to 200 tabular, matrix, or summary reports that you recently viewed. To get additional details on reports by format, name, and other fields, use a SOQL query on the Report object.

Usage

sf_list_reports(recent = FALSE, as_tbl = TRUE, verbose = FALSE)

Arguments

recent	logical; an indicator of whether to return the 200 most recently viewed reports or to invoke a query on the Report object to return all reports in the Org. By default, this argument is set to FALSE meaning that all of the reports, not just the most recently viewed reports are returned. Note that the default behavior of the reports list endpoint in the Reports and Dashboards REST API is only the most recently viewed up to 200 reports.
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

tbl_df by default, or a list depending on the value of argument as_tbl

Salesforce Documentation

• Documentation

• Example

Note

This function will only return up to 200 of recently viewed reports when the recent argument is set to TRUE. For a complete details you must use sf_query on the report object.

See Also

Other Report functions: sf_copy_report(), sf_create_report(), sf_delete_report(), sf_describe_report_type(), sf_describe_report(), sf_execute_report(), sf_list_report_fields(), sf_list_report_filter_operators(), sf_list_report_types(), sf_query_report(), sf_run_report(), sf_update_report()

Examples

## Not run: 
# to return all possible reports, which is queried from the Report object
reports <- sf_list_reports()

# return the results as a list
reports_as_list <- sf_list_reports(as_tbl=FALSE)

# return up to 200 recently viewed reports
all_reports <- sf_list_reports(recent=TRUE)

## End(Not run)

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