Dashboard Results

Syntax

URI

/vXX.X/analytics/dashboards/dashboardID

Or, with optional parameters:

/vXX.X/analytics/dashboards/dashboardID ?runningUser=runningUserID&filter1=filter1ID&filter2=filter2ID&filter3=filter3ID

Formats

JSON

HTTP methods

Method	Description
GET	Returns metadata, data, and status for the specified dashboard. See this example.
POST	Returns details about one or more dashboard components from a specified dashboard. See this example.
PUT	Triggers a dashboard refresh. See this example.
PATCH	Saves a dashboard. See this example.
DELETE	Deletes a dashboard. See this example.

Authentication

Authorization: Bearer token

Parameters

The following optional parameters can be used with the GET and PUT methods:

Parameter Name	Description
runningUser	Identifier of the running user. Gives an error if the user is not allowed to change the running user, or if the selected running user is invalid.
filter1	Identifier of the selected filter option for the first filter. Gives an error if the filter option is invalid.
filter2	Identifier of the selected filter option for the second filter. Gives an error if the filter option is invalid.
filter3	Identifier of the selected filter option for the third filter. Gives an error if the filter option is invalid.

GET, POST, and PUT Response body

Attributes

Property	Type	Description
dashboardId	String	Unique identifier of dashboard.
dashboardName	String	Dashboard name.
statusUrl	Url	The URL of the status resource for the dashboard.
type	String	This property is always set to Dashboard.

Component data

Property	Type	Description
componentId	String	Unique identifier of the component.
reportResult	Report results	Report metadata and summary data for the dashboard component. Uses the same data format as the Report API.
status	Component status	Queue and data status of the component.

Component status

Property	Type	Description
dataStatus	String	Status of the data set of the component. Value can be: NODATA: The data set was never generated or is invalid due to a change in the report. DATA: The data set is available and was last refreshed at the refreshDate. ERROR: A component error has occurred. Details can be found in errorCode, errorMessage, and errorSeverity.
errorCode	String	Unique identifier of error message. This property is only populated in case of error.
errorMessage	String	Localized error message. This property is only populated in case of error.
errorSeverity	String	Severity of error code and message. Value can be: Error Warning This property is only populated in case of error.
refreshDate	Date and time string	Date and time of last refresh in ISO-8601 format.
refreshStatus	String	Refresh status of the component. Value can be: IDLE: The component is not currently being refreshed. RUNNING: The component is currently being refreshed.

Dashboard metadata

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

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

picklistColors

Property	Type	Description
color	String	The color in hexadecimal format used to represent a picklist value.

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.

Break point

Property	Type	Description
aggregateName	String	Aggregate column developer name that the break points have been applied to.
breaks	Break[]	Break values for a break point.

Break

Property	Type	Description
color	String	A hex value representing the color for the break point. A color value of black displays only 1 character (0) instead of 6 characters (000000). Note
lowerBound	Number	Lower bound for the break point.
upperBound	Number	Upper bound for the break point.

Table column

Property	Type	Description
column	String	Developer name for the aggregate or grouping column.
isPercent	Boolean	Indicates whether the column value is shown as a percent.
scale	Number	The number of decimal places for the column value.
showTotal	Boolean	Indicates whether the column shows the total.
type	String	Type of the column. Value can be: aggregate grouping

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.

tableChatterPhotoUrls

Property	Type	Description
chatterPhotoUrl	String	URL pointing to a user's Chatter photo.

PUT Response body

POST Request body