---
schema_version: "1"
id: e6cf8e6025d5dcb7b0856e51ad37adf737127978904c056255d3978f133f566e
title: Lens
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_responses_lens.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 23a1a86bc4fa69a8908dcce0b2c124f3ae3e229a0c998d9fe32390f53290e95c
description: Am Analytics lenses.
---
# Lens

Am Analytics lenses.

## Properties

Lens inherits properties from the abstract [Base Templated Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_templated_asset.htm "A base Analytics asset created from a template."). These base properties appear in Lens 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="d395001e65">Property Name</th>

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

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

              <th class="featureTableHeader vertical-align-top " id="d395001e74">Filter Group and Version</th>

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

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d395001e65" data-title="Property Name"><samp class="codeph nolang">allow​Preview</samp></td>

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

              <td class="entry" headers="d395001e71" data-title="Description">Indicates whether the user is allowed to preview the lens.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

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

            </tr>

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

              <td class="entry" headers="d395001e68" 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_responses_asset_reference.htm" title="An Analytics asset reference.">Asset​Reference</a></td>

              <td class="entry" headers="d395001e71" data-title="Description">
                <strong class="ph b">DEPRECATED</strong> A reference to the dataset used to create this
                lens.
              </td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

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

            </tr>

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

              <td class="entry" headers="d395001e68" 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_responses_asset_reference.htm" title="An Analytics asset reference.">Asset​Reference</a>[]
              </td>

              <td class="entry" headers="d395001e71" data-title="Description">A list of the datasets that the lens uses.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 43.0</td>

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

            </tr>

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 44.0</td>

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

            </tr>

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

              <td class="entry" headers="d395001e68" 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_responses_lens_file.htm" title="A file used to generate a lens.">Lens​File</a>[]
              </td>

              <td class="entry" headers="d395001e71" data-title="Description">The list of the lens files.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Medium, 36.0</td>

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

            </tr>

            <tr>
              <td class="entry" headers="d395001e65" data-title="Property Name"><samp class="codeph nolang">files​Url</samp></td>

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

              <td class="entry" headers="d395001e71" data-title="Description">The URL to the lens files.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

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

            </tr>

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

              <td class="entry" headers="d395001e68" 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_responses_asset_reference.htm" title="An Analytics asset reference.">Asset​Reference</a></td>

              <td class="entry" headers="d395001e71" data-title="Description">A reference to the folder in which this lens is stored.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

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

            </tr>

            <tr>
              <td class="entry" headers="d395001e65" data-title="Property Name"><samp class="codeph nolang">histories​Url</samp></td>

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

              <td class="entry" headers="d395001e71" data-title="Description">The URL for the lens histories associated with this lens.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 44.0</td>

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

            </tr>

            <tr>
              <td class="entry" headers="d395001e65" data-title="Property Name"><samp class="codeph nolang">refresh​Date</samp></td>

              <td class="entry" headers="d395001e68" data-title="Type">Date</td>

              <td class="entry" headers="d395001e71" data-title="Description">The date of the most recent current dataset that is used by the lens, in ISO8601 date
                format.</td>

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

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

            </tr>

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

              <td class="entry" headers="d395001e68" 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_responses_lens_state.htm" title="The state for an Analytics lenses.">Lens​State</a></td>

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

              <td class="entry" headers="d395001e74" data-title="Filter Group and Version">Big, 36.0</td>

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

            </tr>

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

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

              <td class="entry" headers="d395001e71" 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="d395001e74" data-title="Filter Group and Version">Small, 51.0</td>

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

            </tr>

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

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

              <td class="entry" headers="d395001e71" data-title="Description">The visualization type used for this lens. Valid values are: 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="d395001e74" data-title="Filter Group and Version">Small, 36.0</td>

              <td class="entry" headers="d395001e77" data-title="Available Version">36.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.")