Save a Dashboard

Use a PATCH request on the Dashboard Results resource to save changes to a dashboard.

Example Usage

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

Example Request Body

1{
2  "dashboardMetadata" : {
3    "name" : "Sales Dashboard",
4  }
5}

Example Response Body

1{
2  "componentData" : [ {
3    "componentId" : "01aD0000000a36LIAQ",
4    "reportResult" : {
5      "attributes" : null,
6      "allData" : true,
7      "factMap" : {
8        "T!T" : {
9          "aggregates" : [ {
10            "label" : "USD 67,043,365.50",
11            "value" : 67043365.50166918337345123291015625
12          } ]
13        },
14        "0!T" : {
15          "aggregates" : [ {
16            "label" : "USD 10,083.33",
17            "value" : 10083.333333333333939663134515285491943359375
18          } ]
19        },
20        "1!T" : {
21          "aggregates" : [ {
22            "label" : "USD 25,016,768.67",
23            "value" : 25016768.670066006481647491455078125
24          } ]
25        },
26        "2!T" : {
27          "aggregates" : [ {
28            "label" : "USD 42,016,513.50",
29            "value" : 42016513.49826984107494354248046875
30          } ]
31        }
32      },
33      "groupingsAcross" : null,
34      "groupingsDown" : {
35        "groupings" : [ {
36          "groupings" : [ ],
37          "key" : "0",
38          "label" : "-",
39          "value" : null
40        }, {
41          "groupings" : [ ],
42          "key" : "1",
43          "label" : "Existing Business",
44          "value" : "Existing Business"
45        }, {
46          "groupings" : [ ],
47          "key" : "2",
48          "label" : "New Business",
49          "value" : "New Business"
50        } ]
51      },
52      "hasDetailRows" : false,
53      "reportExtendedMetadata" : {
54        "aggregateColumnInfo" : {
55          "s!AMOUNT" : {
56            "acrossGroupingContext" : null,
57            "dataType" : "currency",
58            "downGroupingContext" : null,
59            "label" : "Sum of Amount"
60          }
61        },
62        "detailColumnInfo" : { },
63        "groupingColumnInfo" : {
64          "TYPE" : {
65            "dataType" : "picklist",
66            "groupingLevel" : 0,
67            "label" : "Type"
68          }
69        }
70      },
71      "reportMetadata" : {
72        "aggregates" : [ "s!AMOUNT" ],
73        "chart" : null,
74        "currency" : "USD",
75        "description" : null,
76        "detailColumns" : [ ],
77        "developerName" : "Simple_Test",
78        "division" : null,         
79        "folderId" : "00lR0000000M8IiIAK",
80        "groupingsAcross" : [ ],
81        "groupingsDown" : [ {
82          "dateGranularity" : "None",
83          "name" : "TYPE",
84          "sortAggregate" : null,
85          "sortOrder" : "Asc"
86        } ],
87        "hasDetailRows" : false,         
88        "hasRecordCount" : true,
89        "historicalSnapshotDates" : [ ],
90        "id" : "00OD0000001g2nWMAQ",
91        "name" : "Simple Test",
92        "reportBooleanFilter" : null,
93        "reportFilters" : [ ],
94        "reportFormat" : "SUMMARY",
95        "reportType" : {
96          "label" : "Opportunities",
97          "type" : "Opportunity"
98        },
99        "scope" : "organization",         
100        "showGrandTotal" : true,         
101        "showSubtotals" : true,         
102        "sortBy" : [ ],         
103        "standardDateFilter" : { "column" : "CLOSE_DATE", "durationValue" : "CUSTOM", "endDate" : null, "startDate" : null },
104        "standardFilters" : [ 
105          { "name" : "open", "value" : "all" }, 
106          { "name" : "probability", "value" : ">0" } ]
107      }
108    },
109    "status" : {
110      "dataStatus" : "DATA",
111      "errorCode" : null,
112      "errorMessage" : null,
113      "errorSeverity" : null,
114      "refreshDate" : "2014-04-09T00:28:16.000+0000",
115      "refreshStatus" : "IDLE"
116    }
117  } ],
118  "dashboardMetadata" : {
119    "attributes" : {
120      "dashboardId" : "01ZD00000007S89MAE",
121      "dashboardName" : "Service Dept Dashboard",
122      "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status",
123      "type" : "Dashboard"
124    },
125    "canChangeRunningUser" : false,
126    "components" : [ {
127      "componentData" : 0,
128      "footer" : null,
129      "header" : null,
130      "id" : "01aD0000000a36LIAQ",
131      "properties" : {
132        "aggregates" : [ { "name" : "s!AMOUNT" } ],
133        "autoSelectColumns" : false,         
134        "groupings" : null,
135        "maxRows" : null,
136        "sort" : { "column" : "TYPE", "sortOrder" : "asc" },
137        "useReportChart" : false,
138        "visualizationProperties" : { 
139          "breakPoints" : [ {             
140            "aggregateName" : "s!AMOUNT",             
141            "breaks" : [ 
142              { "color" : "000000", "lowerBound" : null, "upperBound" : -1 }, 
143              { "color" : "000000", "lowerBound" : -1, "upperBound" : 0 }, 
144              { "color" : "000000", "lowerBound" : 0, "upperBound" : null } ]           
145            } ],           
146            "metricLabel" : null },         
147          "visualizationType" : "Metric" },
148      "reportId" : "00OD0000001g2nWMAQ",
149      "title" : null,
150      "type" : "Report"
151    } ],
152    "description" : null,
153    "developerName" : "Simple_Dashboard",
154    "filters" : [ {
155      "name" : "Amount",
156      "options" : [ {
157        "alias" : null,
158        "endValue" : null,
159        "id" : "0ICD00000004CBiOAM",
160        "operation" : "greaterThan",
161        "startValue" : null,
162        "value" : "USD 2000000"
163      } ],
164      "selectedOption" : null
165    } ],
166    "folderId" : "00lR0000000DrojIAC",
167    "id" : "01ZD00000007S89MAE",
168    "layout" : {
169      "columns" : [ {
170        "components" : [ 0 ]
171      } ]
172    },
173    "name" : "Simple Dashboard",
174    "runningUser" : {
175      "displayName" : "Allison Wheeler",
176      "id" : "005D00000016V2qIAE"
177    }
178  }
179}