Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API
Examples: Reports REST API Resources
Examples: Dashboards REST API Resources
Examples: Analytics Notifications REST API
Reports API Resource Reference
Report Types API Resource Reference
Filter Operators API Resource Reference
Dashboards API Resource Reference
Dashboard List
Dashboard Results
Dashboard Describe
Dashboard Status
Dashboard Filter Options Analysis
Dashboard and Component Error Codes
Analytics Notifications API Resource Reference
Analytics Folders API Resource Reference
PDF

Newer Version Available

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

Dashboard Describe

Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.

Syntax

URI
/vXX.X/analytics/dashboards/dashboardID/describe
Formats
JSON
HTTP methods
GET
Parameters
Parameter Description
loadComponentProperties Optional. Specifies whether or not to return properties for each dashboard component. The default value is true. Has no effect on filtered dashboards. Valid values are:
  • true — Return component properties.
  • false — Don’t return component properties. The properties value instead returns null.
Authentication
Authorization: Bearer token

Example

See this example, Get Dashboard Metadata.

Response body

Property Type Description
attributes Attributes Attributes for the dashboard resource, such as name, identifier, and references to other related resources.
canChangeRunningUser Boolean Indicates whether the user is allowed to select a specific running user. Always true for team dashboards.
canUseStickyFilter Boolean Indicates whether dashboard filters persist after closing the dashboard (true) or not (false). Filters that persist keep the dashboard filtered the next time you open it. Filters persist for users on a per-user basis, so if you apply a filter then it doesn’t persist for other people.
chartTheme String Specifies the dashboard theme. Possible values are:
  • light—Default value. Dashboards have a light background that resembles a glass of milk.
  • dark—Dashboards have a dark background that is reminiscent of the night sky.
colorPalette String Specifies a color palette for use in charts. Possible values are:
  • wildflowers—Default value.
  • aurora
  • nightfall
  • sunrise
  • bluegrass
  • ocean
  • heat
  • dusk
  • pond
  • watermelon
  • fire
  • water
  • lake
  • mineral—Accessible.
components Components[] Ordered array of components in this dashboard.
description String Dashboard description.
dashboardType String Indicates whether a dashboard is a dynamic dashboard, a dashboard with running users, or a standard dashboard. Possible values are:
  • SpecifiedUser — Dashboard readers view data as though they are the person specified by runningUser
  • LoggedInUser — Dashboard readers view data as themselves. The dashboard is a dynamic dashboard.
  • MyTeamUser — Dashboard readers view data as the person specified by runningUser by default. If they have the “View All Data” user permission then they can change the runningUser to anyone. If they have the “View My Team’s Dashboards” user permission then they can change the runningUser to people subordinate to them in the role hierarchy.
developerName String Unique API name of the dashboard.
filters Filters[] Ordered array of filters for this dashboard. The dashboard can have 0-3 filters.
folderId String ID of the folder that contains the dashboard.
id String Unique identifier of dashboard.
layout Layout Component layout for this dashboard.
maxFilterOptions Integer The maximum number of values allowed in a dashboard filter.
name String Dashboard name.
runningUser Running user

The running user, which is either specified at dashboard design time, or is overridden by the runningUser parameter specified in the GET request. For dynamic dashboards, this is always the current user.
Components
Property Type Description
componentData Integer Index into the component data array in the response body.
footer String Footer of the component.
header String Header of the component.
id String Unique identifier of the component.
properties

Properties (for Report component type)

Properties (for Visualforce page component type)

 Component properties, including type-specific visualization properties.
reportId String Unique identifier of the underlying report.
title String Title of the component
type String Type of the component. Value can be:
  • Report
  • VisualforcePage
If the component is an SControl, the value is not set.
Properties (for Report component type)
Property Type Description
aggregates Array of strings
Unique identities for summary or custom summary formula fields in the report. For example:
  • a!Amount represents the average for the Amount column.
  • s!Amount represents the sum of the Amount column.
  • m!Amount represents the minimum value of the Amount column.
  • x!Amount represents the maximum value of the Amount column.
  • s!<customfieldID> represents the sum of a custom field column. For custom fields and custom report types, the identity is a combination of the summary type and the field ID.
autoSelectColumns Boolean Indicates whether groupings and aggregates are automatically selected. Valid values are true and false.
groupings String Report groupings included in the dashboard.
maxRows Number Maximum number of rows to be rendered, based on the sort value.
reportFormat String The format of a dashboard’s source report.
sort Sort Sorting information for the component.
useReportChart Boolean Indicates whether the dashboard component uses the chart as defined in the report. Valid values are true and false.
visualizationProperties

Visualization properties (Chart)

Visualization properties (Table)

Visualization properties (FlexTable)

Visualization properties (Metric)

Visualization properties (Gauge)

 Type-specific visualization properties.
visualizationType String Type of the component. Value can be:
  • Bar
  • Column
  • Donut
  • Funnel
  • Gauge
  • Line
  • Metric
  • Pie
  • Scatter
  • Table
  • FlexTable (As of API Version 41.0. Beta in API Version 41.0)
Sort
Property Type Description
column String Developer name for a sorted column.
sortOrder String Sort order. Value can be:
  • asc
  • desc
Visualization properties (Chart)
Property Type Description
axisRange String Range of values specified for the axis.
groupByType String Type of second-level grouping.
legendPosition String Position of legend on the grid. Valid values are bottom, right, and none.
showValues Boolean Indicates whether to include values in the chart. Valid values are true and false.
Visualization properties (Table)
Property Type Description
breakPoints Break point[] Break points for the table component.
tableColumns Table columns[] Columns of the table component.
Visualization properties (Metric)
Property Type Description
breakPoints Break point[] Break points for the metric component.
metricLabel String Label for the metric component.
Visualization properties (Gauge)
Property Type Description
breakPoints Break point[] Break points for the gauge component.
displayUnits String Specify how to display numbers. Possible values are:
  • whole — Display the true value of the number without rounding it.
  • auto — Display the number rounded to the nearest thousand, million, etc. and displayed as a shortened value. For example, 1,876 displays as 1.9k. In calculating summaries, the true value of the number (1,876) is used , even if 1.9k is displayed.
  • null — Customizing how numbers display isn’t applicable..
showPercentages Boolean Specify whether percentages are displayed (true) or not (false)
showTotal Boolean Indicates whether the total is displayed (true) or not (false).
Properties (for Visualforce page component type)
Property Type Description
pageName String Developer name of the Visualforce page.
height String Height of the Visualforce page, in pixels.
Filters
Property Type Description
errorMessage String If there is no error with a dashboard filter, then null. Otherwise, the error message is returned.
name String Localized display name of filter.
options Filter option Ordered array of possible filter options.
selectedOption Integer

Index of the selected option from the options array. This matches the selection that was made based on the filter1, filter2, or filter3 parameter. Value is null if no option is selected.
Filter option
Property Type Description
alias String Optional alias of the filter option.
id String Unique identifier of the filter option. Used as a value for the filter1, filter2, and filter3 parameters.
operation String
Unique API name for the filter operation. Valid filter operations depend on the data type of the filter field. Value can be:
  • equals
  • notEqual
  • lessThan
  • greaterThan
  • lessOrEqual
  • greaterOrEqual
  • contains
  • notContain
  • startsWith
  • includes
  • excludes
  • within
  • between
value String Value to filter on. Used for all operations except between.
startValue String Start value when using a between operation. Not set for all other operations.
endValue String End value when using a between operation. Not set for all other operations.
Layout
Property Type Description
columns Columns[] Dashboard layout columns. Can have 2 or 3 columns, including empty columns. This property is available only if the dashboard was created using Salesforce Classic.
components Components Layout for dashboards. This property is available only if the dashboard was created using Lightning Experience.
Columns
Property Type Description
components Integer[] Ordered list of components in a column (top to bottom). Components are represented by indices into the array of components in the dashboard metadata object.
Components
Property Type Description
colspan Integer Width of component in columns. For example, if colspan=3, then the component spans 3 columns.
rowspan Integer Height of component in rows. For example, if rowspan=4, then the component spans 4 rows.
column String Column position on the grid.
row String Row position on the grid.
Running user
Property Type Description
displayName String Display name of running user.
id String Returns the ID of the running user specified for the dashboard. If the dashboard is configured to run as the viewing user, returns the user ID of the dashboard creator.