Dashboard

Represents a dashboard, which shows data from custom reports as visual components. Access is read-only.

Introduced in API version 20.0.

describeSObjects(), describeLayout(), query(), retrieve(), search()

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

  • Description:

    Returns the direction of the background fade. Available values are:

    Label is Background Fade Direction.

  • Possible values:

    • Top to Bottom — Top to Bottom
    • Left to Right — Left to Right
    • Diagonal — Diagonal
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Returns the ending fade color in hexadecimal. Label is Ending Color.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Returns the starting fade color in hexadecimal. Label is Starting Color.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 42.0
  • Description: Returns the background theme used for charts.
  • Possible values:
    • dark — dark — Dark Background
    • light — light — Light Background
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 42.0
  • Description: Returns the color palette used for the dashboard.
  • Possible values:

    • Default — Default — Default Palette

    • accessible — accessible — Mineral(Accessible) Palette

    • bluegrass — bluegrass — Branding Palette

      Bluegrass Palette

    • colorSafe — colorSafe — Color Safe Palette

    • dusk — dusk — Dusk Palette

    • earth — earth — Lake Palette

    • fire — fire — Fire Palette

    • gray — gray — Gray Palette

    • heat — heat — Heat Palette

    • justice — justice — Wildflowers Palette

    • nightfall — nightfall — Nightfall Palette

    • pond — pond — Pond Palette

    • sunrise — sunrise — Sunrise Palette

    • tropic — tropic — Ocean Palette

    • unity — unity — Aurora Palette

    • water — water — Water Palette

    • watermelon — watermelon — Watermelon Palette

  • Type: string
  • Properties: Nillable
  • Introduced: API version 32.0
  • Description: Returns the date on which the dashboard results were last refreshed.
  • Type: string
  • Properties: Nillable
  • Introduced: API version 32.0
  • Description: The user whose security settings were used to generate the dashboard results.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Returns the description of the dashboard. Limit: 255 characters.

  • Type: string

  • Properties: Filter, Group, Sort

  • Introduced: API version 14.0

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

    When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description:

    Required. Returns the ID of the Folder that contains the dashboard. See Folder.

    This is a relationship field.

  • Relationship name: Folder

  • Relationship type: polymorphic

  • Refers to: Folder, User

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 35.0
  • Description: Name of the folder that contains the dashboard.

  • Type: picklist

  • Properties: Filter, Group, Restricted picklist, Sort

  • Description:

    Returns the size of the left column of the dashboard.

    Available values are:

  • Possible values:

    • Narrow — Narrow
    • Medium — Medium
    • Wide — Wide

  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Description:

    Returns the size of the middle column of the dashboard.

    Available values are:

  • Possible values:

    • Narrow — Narrow
    • Medium — Medium
    • Wide — Wide

  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 14.0

  • Description:

    The namespace prefix that is associated with this object. Each Developer Edition org 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
    • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

  • Type: picklist

  • Properties: Filter, Group, Restricted picklist, Sort

  • Description:

    Returns the size of the right column in the dashboard.

    Available values are:

  • Possible values:

    • Narrow — Narrow
    • Medium — Medium
    • Wide — Wide

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description:

    Returns the ID of the running user specified for the dashboard.

    If the dashboard was created in Lightning Experience and is configured to run as the viewing user, it returns the user ID of the dashboard creator.

    If the dashboard was created in Salesforce Classic and is configured to run as the logged-in user, returns the user ID of the last specified running user.

    This is a relationship field.

  • Relationship name: RunningUser

  • Relationship type: relationship

  • Refers to: User

  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Returns the body text color in hexadecimal. Label is Text Color.
  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: Returns the title of the dashboard. Limit: 80 characters.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Returns the title text color in hexadecimal. Label is Title Color.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Returns the title font size in points. Label is Title Size.
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
  • Description: Returns the dashboard type. Available values are:
  • Possible values:
    • SpecifiedUser — SpecifiedUser — The dashboard displays data according to the access level of one specific running user.
    • LoggedInUser — LoggedInUser — The dashboard displays data according to the access level of the logged-in user.
    • MyTeamUser — 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.

Use these scopes to help specify the data that your SOQL query returns.

  • allPrivate: Records saved in all users’ private folders.

    Requires the user permission “Manage All Private Reports and Dashboards” and Enhanced Analytics Folder Sharing. If your organization was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and later.

  • created: Records created by the user running the query.

  • everything: All records except records saved in other users’ private folders.

  • mine: Records saved in the private folder of the user running the query.

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

This SOQL query returns dashboards saved in a specific user’s private folder.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.