Set a Sticky Dashboard Filter

Set a default filter value which gets applied to a dashboard when you open it. The default filter value you specify only applies to you (other people won’t see it when they open the dashboard). If you change the filter value while viewing the dashboard, then the filter value you set in the user interface overwrites the value you set via the API. To set sticky filters for a dashboard, canUseStickyFilter must equal true.

Use a PATCH request on the Dashboard Results resource and append the parameter isStickyFilterSave=true to set a sticky filter.

In the request body, set the selectedOption property to the index of the filter option you’d like to apply.

Example Usage

1/services/data/v40.0/analytics/dashboards/0IBR00000004D4iOAE?isStickyFilterSave=true

Example Request Body

1{
2  "filters" : [ {
3    "errorMessage" : null,
4    "id" : "0IBR00000004D4iOAE",
5    "name" : "Billing City",
6    "options" : [ {
7      "alias" : "New York City",
8      "endValue" : null,
9      "id" : "0ICR00000004FtQOAU",
10      "operation" : "equals",
11      "startValue" : null,
12      "value" : "New York City"
13      }, {
14      "alias" : "Chicago",
15      "endValue" : null,
16      "id" : "0ICR00000004FtROAU",
17      "operation" : "equals",
18      "startValue" : null,
19      "value" : "Chicago"
20      }, {
21      "alias" : "Los Angeles",
22      "endValue" : null,
23      "id" : "0ICR00000004FtSOAU",
24      "operation" : "equals",
25      "startValue" : null,
26      "value" : "Los Angeles"
27      }
28    ],
29    "selectedOption" : 1
30    }
31  ]
32}

Example Response Body

If successful, an empty response body is returned.