make_report_execute_url: Report Execute URL generator

View source: R/endpoints-analytics-report.R

make_report_execute_urlR Documentation

Report Execute URL generator

Description

Report Execute URL generator

Usage

make_report_execute_url(report_id, async = TRUE, include_details = FALSE)

Arguments

report_id

character; the Salesforce Id assigned to a created analytics report. It will start with "00O".

async

logical; an indicator, by default set to TRUE, which executes the report asynchronously. If executed asynchronously, this function will return a list of attributes of the created report instance. The results can be pulled down by providing the report id and instance id to the function sf_get_report_instance_results. Refer to the details of the documentation on why executing a report asynchronously is preferred.

include_details

logical; an indicator applying to a synchronous indicating whether the run should return summary data with details.

Value

character; a complete URL (as a string) that will be used to send Reports and Dashboards API calls to. This URL is specific to your instance and the API version being used.

Note

This function is meant to be used internally. Only use when debugging.


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