Dashboard Describe

Syntax

URI

/vXX.X/analytics/dashboards/dashboardID/describe

Formats

JSON

HTTP methods

GET

Authentication

Authorization: Bearer token

Example

Response body

Component

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.
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 (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

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 column[]	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.

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.

Filter

Property	Type	Description
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	Unique identifier of running user.