Salesforce Reports and Dashboards REST API Developer Guide

Overview
Examples
Reports Examples
Create a New Report
Run Reports Synchronously or Asynchronously
Get Report Metadata
Get a List of Report Types
Download Formatted Excel Reports Using the Reports REST API
List Asynchronous Runs of a Report
Filter Reports on Demand
List Recently Viewed Reports
Decode the Fact Map
Get Report Data without Saving Changes to or Creating a Report
Save Changes to Reports
Clone Reports
Delete Reports
Dashboards Examples
Notifications Examples
Reference
PDF

Newer Version Available

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

Get Report Metadata

Report metadata gives information about a report and its report type. It includes information on fields used in the report for filters, groupings, detailed data, and summaries. You can use the metadata to do several things.

  • Find out what fields in the report type you can filter on and by what values.
  • Build custom chart visualizations using the metadata information on fields, groupings, detailed data, and summaries.
  • Change filters in the report metadata during a report run.

To get report metadata, send a GET request to the Describe resource.

Example

This GET request, /services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/describe, to the Describe resource returns metadata for a matrix report. This includes a bucket field, groupings, summaries, and a custom summary formula.