Salesforce Reports and Dashboards REST API Developer Guide

Overview
Examples
Reference
Analytics Notifications
Dashboards
Dashboard List
Dashboard Results
Dashboard Describe
Dashboard Status
Dashboard Filter Options Analysis
Dashboard and Component Error Codes
Filter Operators
Folders
Reports
Report Types
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Dashboards

The Dashboards API provides several resources for accessing and refreshing dashboards.

Resources for the Dashboards API are available at /services/data/<latest API version>/analytics/dashboards. You can query each resource with an HTTP method (such as GET). Use these resources to integrate dashboard data directly into your applications.

Resource Supported HTTP Method Description
Dashboard List

GET

POST

Returns a list of recently used dashboards.

Makes a copy of a dashboard.
Dashboard Results

GET

POST

PUT

PATCH

DELETE

Returns the metadata, data, and status for the specified dashboard.

Returns details about specified dashboard components.

Triggers a dashboard refresh.

Saves a dashboard.

Deletes a dashboard.
Dashboard Status GET Returns the status for the specified dashboard.
Dashboard Describe GET Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.
Dashboard Filter Options Analysis POST Verifies that dashboard filter options are compatible with report fields. Specify the reportId of a dashboard’s components’ source report.