---
schema_version: "1"
id: 1a853d4573a87606304e0e59f91d5c6160ffbf98210875f823285249d402d501
title: Lens Resource
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_resources_lenses_id.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 51b6c8ffa14d3ec44855408ac3b15e244e266282fa763d7c605c23c936622db2
description: Returns, deletes, or updates the lens with the specified ID or API name.
---
# Lens Resource

Returns, deletes, or updates the lens with the specified ID or API name.

## Resource URL

/wave/lenses/<lensIdOrApiName>

## Formats

JSON

## Available Version

36.0

## Available in Postman

To view and test a working example of this resource, see [getLens](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-dd502784-37ea-4d53-a297-c5af5d933169?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response.").

## Available Components

- Apex — [Wave.Lenses.getLens()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_query.htm)
- Aura — [<wave:sdk> describeLens()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm)

## HTTP Methods

GET DELETE PATCH

![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png)

#### Note

If the specified lens is archived (moved to the Recycle Bin), a GET request returns a 404 Not Found error.

## GET and PATCH Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| lens​Id​Or​Api​Name | ID | The lens ID or API name to return or update. | Required | 36.0 |

## GET and PATCH Response Body

[Lens](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm "Am Analytics lenses.")

## PATCH Request Body

[Lens Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_input.htm "An Analytics lens.")