---
schema_version: "1"
id: 4843ac4576340302557b5090919c0c07aee8c14da0971ddecdb5f2993835dfdf
title: WaveLens
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_wavelens.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_wavelens.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 71802bccf1f7c247651f8a84c090643eda03008bb94858c2a5c3de958e7bbe5d
description: Represents the WaveLens object in the Analytics application.
---
# WaveLens

Represents the WaveLens object in the Analytics application.

This type extends to [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

When using Metadata API to work with Analytics lenses, consider that:

- If a lens is archived (moved to the Recycle Bin), retrieving it doesn't return its metadata. Deploying changes to an archived lens fails with an error stating that the lens is in the Recycle Bin.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## File Suffix and Directory Location

WaveLens components have the suffix .wlens and are stored in the wave folder.

## Version

WaveLens components are available in API version 37.0 and later.

## Fields

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



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1016571e118">Field Name</th>

              <th class="featureTableHeader  " id="d1016571e121">Field Type</th>

              <th class="featureTableHeader  " id="d1016571e124">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">application</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The internal name of the application.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">datasets</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">A reference to the dataset used to create this lens.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">dateVersion</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">int</td>

              <td class="entry" headers="d1016571e124" data-title="Description">The date version used for this lens.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">The dashboard description that appears in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The user interface label name of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">templateAssetSourceName</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Links the lens to the template used to create it. Null for assets not created
                from a template. </td>

            </tr>

            <tr>
              <td class="entry" headers="d1016571e118" data-title="Field Name"><span class="keyword parmname">visualizationType</span></td>

              <td class="entry" headers="d1016571e121" data-title="Field Type">string</td>

              <td class="entry" headers="d1016571e124" data-title="Description">Required. The visualization type to be used for this lens. Valid values are:
                <a name="ac_viz_type_list"><!-- --></a>
                <ul class="ul bulletList" id="ac_viz_type_list">
                  <li class="li">
                    <samp class="codeph nolang">calheatmap</samp>—Calendar heat map
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">comparisontable</samp>—Comparison
                    table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">heatmap</samp>—Heat map
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">hbar</samp>—Horizontal bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">hbarhdot</samp>—Horizontal dot plot
                  </li>

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

                  <li class="li">
                    <samp class="codeph nolang">parallelcoords</samp>—Parallel
                    coordinates
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">pie</samp>—Donut
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">pivottable</samp>—Pivot table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">scatter</samp>—Scatter plot
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stackhbar</samp>—Stacked horizontal
                    bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">stackvbar</samp>—Stacked vertical
                    bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">time</samp>—Time line
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">valuestable</samp>—Values table
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">vbar</samp>—Vertical bar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">vdot</samp>—Vertical dot plot
                  </li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a WaveLens component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveLens xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <content xsi:nil="true"/>
  <application\>dev\_\_app</application\>
  <datasets\>dev\_\_abc</datasets\>
  <masterLabel\>lens1</masterLabel\>
  <description\>lens in shared app</description\>
  <visualizationType\>hbar</visualizationType\>
</WaveLens\>  

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).