sf_list_report_filter_operators: List report filter operators

View source: R/analytics-report.R

sf_list_report_filter_operatorsR Documentation

List report filter operators

Description

[Experimental]

Use the Filter Operators API to get information about which filter operators are available for reports and dashboards. The Filter Operators API is available in API version 40.0 and later.

Usage

sf_list_report_filter_operators(as_tbl = TRUE, verbose = FALSE)

Arguments

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

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_types(), sf_list_reports(), sf_query_report(), sf_run_report(), sf_update_report()

Examples

## Not run: 
report_filters <- sf_list_report_filter_operators()
unique_supported_fields <- report_filters %>% distinct(supported_field_type)

# operators to filter a picklist field
picklist_field_operators <- report_filters %>% filter(supported_field_type == "picklist")

## End(Not run)

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