---
schema_version: "1"
id: 615606b91107a2944c838f45addaa22f0ae563a3b522b83a3d2081c611f59444
title: Dashboard Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_requests_dashboard_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: af5551bf28324b9f685d09c791eb1648f6015877f2efc44ddb8c1d64bef5b7d1
description: An Analytics dashboard.
---
# Dashboard Input

An Analytics dashboard.

## Properties

DashboardInput inherits properties from the abstract [Base Asset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_reference_input.htm "The base Analytics asset."). These base properties appear in DashboardInput alongside the properties defined explicitly in the following table.

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d31623e65">Parameter Name</th>

              <th class="featureTableHeader vertical-align-top " id="d31623e68">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d31623e71">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d31623e74">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d31623e77">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">cloned​Template​Origin</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">String</td>

              <td class="entry" headers="d31623e71" data-title="Description">If the asset was cloned from an asset that was created from a template, this is the template origin of the original asset.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">56.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">current​History​Id</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">String</td>

              <td class="entry" headers="d31623e71" data-title="Description">The current saved history id to display for the dashboard.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">date​Version</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">Integer</td>

              <td class="entry" headers="d31623e71" data-title="Description">The version of dates used by the dashboard. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">1</li>

                  <li class="li">2</li>

                </ul>
              </td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">folder</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm" title="An Analytics asset reference.">Asset​Reference​Input​Representation</a></td>

              <td class="entry" headers="d31623e71" data-title="Description">The folder in which this dashboard is
                stored.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Required for POST, optional for PATCH</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">history​Label</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">String</td>

              <td class="entry" headers="d31623e71" data-title="Description">A history label to tag the dashboard version
                being saved.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">layout​Auto​Sync</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">String</td>

              <td class="entry" headers="d31623e71" data-title="Description">Indicates whether the dashboard has auto sync enabled for layouts(<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">mobile​Disabled</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">Boolean</td>

              <td class="entry" headers="d31623e71" data-title="Description">Indicates whether the dashboard is disabled
                for mobile (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">semantic​Models</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_mapped_sdm_input.htm" title="A mapped Tableau Next semantic model.">Mapped​SDM​Input</a>[]
              </td>

              <td class="entry" headers="d31623e71" data-title="Description">A list of sementic models for this dashboard.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">67.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">state</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboard_state_input_rep.htm#DashboardStateInputRepresentation">Dashboard​State​Input</a></td>

              <td class="entry" headers="d31623e71" data-title="Description">The state of the dashboard.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Required for POST, optional for PATCH</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">type</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">Connect​Wave​Asset​Type​Enum</td>

              <td class="entry" headers="d31623e71" data-title="Description">The asset type. The default type is Dashboard.
                Valid types are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Collection</samp></li>

                  <li class="li"><samp class="codeph nolang">Component</samp></li>

                  <li class="li"><samp class="codeph nolang">Contextual​Dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">Dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">Dashboard​Saved​View</samp></li>

                  <li class="li"><samp class="codeph nolang">Dashboard​Snapshot</samp></li>

                  <li class="li"><samp class="codeph nolang">Data​Cloud​Report</samp></li>

                  <li class="li"><samp class="codeph nolang">Data​Connector</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataflow</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataflow​Job</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataflow​Job​Node</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataset</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataset​Shard</samp></li>

                  <li class="li"><samp class="codeph nolang">Dataset​Version</samp></li>

                  <li class="li"><samp class="codeph nolang">External​Data</samp></li>

                  <li class="li"><samp class="codeph nolang">Folder</samp></li>

                  <li class="li"><samp class="codeph nolang">Lens</samp></li>

                  <li class="li"><samp class="codeph nolang">Lightning​Component</samp></li>

                  <li class="li"><samp class="codeph nolang">Lightning​Dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">Lightning​Dashboard​Folder</samp></li>

                  <li class="li"><samp class="codeph nolang">Recipe</samp></li>

                  <li class="li"><samp class="codeph nolang">Recipe​Configuration</samp></li>

                  <li class="li"><samp class="codeph nolang">Recipe​Model</samp></li>

                  <li class="li"><samp class="codeph nolang">Replicated​Dataset</samp></li>

                  <li class="li"><samp class="codeph nolang">Report</samp></li>

                  <li class="li"><samp class="codeph nolang">Report​Folder</samp></li>

                  <li class="li"><samp class="codeph nolang">Story</samp></li>

                  <li class="li"><samp class="codeph nolang">Tableau​Dashboard</samp></li>

                  <li class="li"><samp class="codeph nolang">Tableau​Workbook</samp></li>

                  <li class="li"><samp class="codeph nolang">Template</samp></li>

                  <li class="li"><samp class="codeph nolang">Widget</samp></li>

                  <li class="li"><samp class="codeph nolang">Workflow</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">xmd</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_input.htm" title="The extended metadata (Xmd) for an Analytics dataset version.">Xmd​Input</a></td>

              <td class="entry" headers="d31623e71" data-title="Description">The asset XMD of the dashboard.</td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d31623e65" data-title="Parameter Name"><samp class="codeph nolang">visibility</samp></td>

              <td class="entry" headers="d31623e68" data-title="Type">Connect​Wave​Asset​Visibility​Type</td>

              <td class="entry" headers="d31623e71" data-title="Description">Indicates whether the asset is hidden from users with view access or not.
                Valid values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">All</samp> (Show all assets)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Limited</samp> (Hide assets from viewers with view
                    access)
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d31623e74" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d31623e77" data-title="Available Version">51.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Dashboards List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm "Returns a list of Analytics dashboard or creates a dashboard.")
- [Dashboard Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm "Returns, deletes, or updates the dashboard with the specified ID or API name.")