---
schema_version: "1"
id: 45fa00f5325230999dabcd12a2ffa8687f3cf20916089e39c86dc29bf8eb8d5f
title: Lens Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_requests_lens_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4af966f1f77f3d14825eb1a9a3634dfbac2d87fe23ec92e762e62a40286430f0
description: An Analytics lens.
---
# Lens Input

An Analytics lens.

## Properties

Lens Input 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 Lens Input 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="d44683e65">Property Name</th>

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

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

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

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

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d44683e65" data-title="Property Name"><samp class="codeph nolang">datasets</samp></td>

              <td class="entry" headers="d44683e68" 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</a>[]
              </td>

              <td class="entry" headers="d44683e71" data-title="Description">The list of datasets used to create this lens.</td>

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

              <td class="entry" headers="d44683e77" data-title="Available Version">43.0</td>

            </tr>

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

              <td class="entry" headers="d44683e68" 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</a></td>

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

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

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

            </tr>

            <tr>
              <td class="entry" headers="d44683e65" data-title="Property Name"><samp class="codeph nolang">history​label</samp></td>

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

              <td class="entry" headers="d44683e71" data-title="Description">The history label of the lens version being
                saved.</td>

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

              <td class="entry" headers="d44683e77" data-title="Available Version">46.0</td>

            </tr>

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

              <td class="entry" headers="d44683e68" 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_lens_state_input.htm" title="The state for an Analytics lens.">Lens​State​Input</a></td>

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

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

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

            </tr>

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

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

              <td class="entry" headers="d44683e71" 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="d44683e74" data-title="Required or Optional">Optional</td>

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

            </tr>

            <tr>
              <td class="entry" headers="d44683e65" data-title="Property Name"><samp class="codeph nolang">visualization​Type</samp></td>

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

              <td class="entry" headers="d44683e71" data-title="Description">The visualization type of the lens. Valid values are:
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bullet</samp></li>

                  <li class="li"><samp class="codeph nolang">Calendar​Heat​Map</samp></li>

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

                  <li class="li"><samp class="codeph nolang">Comparison​Table</samp></li>

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

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

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

                  <li class="li"><samp class="codeph nolang">Heat​Map</samp></li>

                  <li class="li"><samp class="codeph nolang">Horizontal​Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">Horizontal​Dot</samp></li>

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

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

                  <li class="li"><samp class="codeph nolang">Parallel​Coordinates</samp></li>

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

                  <li class="li"><samp class="codeph nolang">Pivot​Table</samp></li>

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

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

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

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

                  <li class="li"><samp class="codeph nolang">Stack​Waterfall</samp></li>

                  <li class="li"><samp class="codeph nolang">Stacked​Horizontal​Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">Stacked​Vertical​Bar</samp></li>

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

                  <li class="li"><samp class="codeph nolang">Time​Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">Time​Combo</samp></li>

                  <li class="li"><samp class="codeph nolang">Values​Table</samp></li>

                  <li class="li"><samp class="codeph nolang">Vertical​Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">Vertical​Dot</samp></li>

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

                </ul>
              </td>

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

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

            </tr>

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

              <td class="entry" headers="d44683e68" 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="d44683e71" data-title="Description">The asset XMD of the lens.</td>

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

              <td class="entry" headers="d44683e77" data-title="Available Version">43.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Lenses List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm "Returns a list of Analytics lenses or creates a lens.")
- [Lens Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm "Returns, deletes, or updates the lens with the specified ID or API name.")