Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API Developer Guide Version 53.0, Winter ’22 @salesforcedocs Last updated: September 9, 2021 © Copyright 2000–2021 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc., as are other names and marks. Other marks appearing herein may be trademarks of their respective owners. CONTENTS Chapter 1: Overview . 1 Build the Resource URL . 2 Requirements and Limitations . 2 API End-of-Life . 3 Chapter 2: Examples . 4 Reports Examples . 5 Create a New Report . 5 Run Reports Synchronously or Asynchronously . 35 Get Report Metadata . 42 Get a List of Report Types . 46 Download Formatted Excel Reports Using the Reports REST API . 51 List Asynchronous Runs of a Report . 52 Filter Reports on Demand . 53 List Recently Viewed Reports . 56 Decode the Fact Map . 57 Get Report Data without Saving Changes to or Creating a Report . 60 Save Changes to Reports . 71 Clone Reports . 72 Delete Reports . 74 Dashboards Examples . 74 Get List of Recently Used Dashboards . 74 Get Dashboard Results . 74 Filter Dashboard Results . 78 Get Dashboard Status . 79 Refresh a Dashboard . 80 Save a Dashboard . 80 Set a Sticky Dashboard Filter . 84 Return Details About Dashboard Components . 85 Get Dashboard Metadata . 100 Clone a Dashboard . 109 Delete a Dashboard . 109 Notifications Examples . 109 Get Analytics Notifications . 109 Create an Analytics Notification . 112 Save Changes to an Analytics Notification . 113 Delete an Analytics Notification . 114 Check Limits for Analytics Notifications . 114 Contents Chapter 3: Reference . 116 Analytics Notifications . 117 Analytics Notification List . 117 Analytics Notification . 123 Analytics Notification Limits . 129 Dashboards . 130 Dashboard List . 131 Dashboard Results . 132 Dashboard Describe . 145 Dashboard Status . 155 Dashboard Filter Options Analysis . 156 Dashboard and Component Error Codes . 158 Filter Operators . 159 Filter Operator List . 160 Folders . 167 Folder Collections . 167 Folder Operations . 171 Folder Shares . 175 Folder Share by ID . 178 Folder Share Recipients . 181 Folder Child Operations . 184 Reports . 185 Report . 186 Describe . 200 Execute Sync . 220 Execute Async . 227 Instances List . 232 Instance Results . 233 Report List . 235 Query . 239 Report Fields . 253 Report Error Codes . 265 Report Types . 267 Report Type List . ..

View Full Text

Details

  • File Type
    pdf
  • Upload Time
    -
  • Content Languages
    English
  • Upload User
    Anonymous/Not logged-in
  • File Pages
    294 Page
  • File Size
    -

Download

Channel Download Status
Express Download Enable

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

  • Not to be reproduced or distributed without explicit permission.
  • Not used for commercial purposes outside of approved use cases.
  • Not used to infringe on the rights of the original creators.
  • If you believe any content infringes your copyright, please contact us immediately.

Support

For help with questions, suggestions, or problems, please contact us