Salesforce Reports and Dashboards REST API Developer Guide

Overview
Build the Resource URL
Requirements and Limitations
API End-of-Life Policy
Examples
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Overview

The Reports and Dashboards REST API gives you programmatic access to your report and dashboard data as defined in the report builder and dashboard builder. The API lets you integrate the data into any web or mobile application, inside or outside the Salesforce platform. For example, you might use the API to trigger a Chatter post with a snapshot of top-performing reps each quarter.

The Reports and Dashboards REST API is part of standard Salesforce functionality and doesn't require a separate add-on or license.

The Reports and Dashboards REST API will revolutionize the way you access and visualize your data. You can:

  • Integrate report data into custom objects.
  • Define rich visualizations on top of the API to animate the data.
  • Build custom dashboards.
  • Automate reporting tasks.

At a high level, the API resources let you query and filter report data. You can:

  • Run tabular, summary, or matrix reports synchronously or asynchronously.
  • Filter for specific data on the fly.
  • Query report metadata.

You can also work with dashboard resources to:

  • Get a list of recently used dashboards.
  • Get dashboard metadata and data.
  • Query dashboard status.
  • Refresh dashboards.