View source: R/analytics-report.R
sf_describe_report | R Documentation |
Retrieves report, report type, and related metadata for a tabular, summary, or matrix report.
sf_describe_report(report_id, verbose = FALSE)
report_id |
|
verbose |
|
Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are summaries, row or column groupings, filters saved to the report, and so on.
Report type metadata tells you about all the fields available in the report type, those you can filter, and by what filter criteria.
Report extended metadata tells you about the fields that are summaries, groupings, and contain record details in the report.
list
containing up to 4 properties that describe the report:
Report type along with the URL to retrieve common objects and joined metadata.
Unique identifiers for groupings and summaries.
Fields in each section of a report type plus filter information for those fields.
Additional information about summaries and groupings.
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report_type()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
## Not run:
# pull a list of up to 200 recent reports
# (for a full list you must use sf_query on the Report object)
reports <- sf_list_reports()
# id for the first report
reports[[1,"id"]]
# describe that report type
described_report <- sf_describe_report_type(unique_report_types[[1,"id"]])
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.