Dashboard

Represents a dashboard, which shows data from custom reports as visual components. Access is read-only.This object is available in API version 20.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field	Details
BackgroundDirection	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the direction of the background fade. Available values are: `Top to Bottom` `Left to Right` `Diagonal` (default value) Label is Background Fade Direction.
BackgroundEnd	Type int Properties Filter, Group, Sort Description Returns the ending fade color in hexadecimal. Label is Ending Color.
BackgroundStart	Type int Properties Filter, Group, Sort Description Returns the starting fade color in hexadecimal. Label is Starting Color.
Description	Type string Properties Filter, Group, Nillable, Sort Description Returns the description of the dashboard. Limit: 255 characters.
DeveloperName	Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is Dashboard Unique Name.
FolderId	Type reference Properties Filter, Group, Sort Description Required. Returns the ID of the Folder that contains the dashboard. See Folder.
IsDeleted	Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
LeftSize	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the size of the left column of the dashboard. Available values are: `Narrow` `Medium` `Wide`
MiddleSize	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Returns the size of the middle column of the dashboard. Available values are: `Narrow` `Medium` `Wide`
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
RightSize	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the size of the right column in the dashboard. Available values are: `Narrow` `Medium` `Wide`
RunningUserId	Type reference Properties Filter, Group, Sort Description Returns the ID of the running user specified for the dashboard. If the dashboard is dynamic, it returns the user ID of the viewing user.
TextColor	Type int Properties Filter, Group, Sort Description Returns the body text color in hexadecimal. Label is Text Color.
Title	Type string Properties Filter, Group, Sort Description Returns the title of the dashboard. Limit: 80 characters.
TitleColor	Type int Properties Filter, Group, Sort Description Returns the title text color in hexadecimal. Label is Title Color.
TitleSize	Type int Properties Filter, Group, Sort Description Returns the title font size in points. Label is Title Size.
Type	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Returns the dashboard type. Available values are: `SpecificUser`—The dashboard displays data according to the access level of one specific running user. `LoggedInUser`—The dashboard displays data according to the access level of the logged-in user. `MyTeamUser`—The dashboard displays data according to the access level of the logged-in user, and managers can view dashboards from the point of view of users beneath them in the role hierarchy.

Usage

Provides read only access to the current values in the dashboard fields.