Save a Dashboard with a Custom Lightning Web Component (Beta)

You can save a dashboard with a custom Lightning web component by sending a PATCH request to the Dashboard Results resource.

This feature is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer’s sole discretion.

Note

Example Usage

1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE

Example Request Body

1{
2    "components": [{
3        "header": "",
4        "properties": {
5            "content": {
6                "componentParameters": "{\"componentApiName\":\"c:kpiDashboard\",\"properties\":\"{\\\"maxCards\\\":1,\\\"showProgressBars\\\":true,\\\"showSummary\\\":false}\"}"
7            },
8            "visualizationType": "LightningWebComponent"
9        },
10        "type": "Dashboard",
11        "componentData": 0
12    }]
13}

Example Response Body

1components" : [{
2    "chartTheme" : null,
3    "componentData" : null,
4    "footer" : null,
5    "header" : null,
6    "id" : "01aSG0000088inFYAQ",
7    "lastModifiedDate" : "2025-12-18T05:03:56Z",
8    "properties" : {
9        "content" : {
10            "componentParameters" : "{\"componentApiName\":\"c:kpiDashboard\",\"properties\":\"{\\\"maxCards\\\":1,\\\"showProgressBars\\\":true,\\\"showSummary\\\":false}\"}"
11        },
12        "visualizationType" : "LightningWebComponent"
13    },
14    "reportId" : null,
15    "title" : null,
16    "type" : "Dashboard"
17}]

Salesforce Reports and Dashboards REST API Developer Guide

Save a Dashboard with a Custom Lightning Web Component (Beta)