Filter Dashboard Results

You can filter dashboard results, status, or refresh requests, by using filter parameters.

Dashboard results are always unfiltered, unless you have specified filter parameters in your request. When requesting a dashboard result, status, or refresh, you can specify up to three optional filter parameters: filter1, filter2 and filter3. These parameters allow you to apply filter options, which can be selected from the filters that are currently defined for the dashboard. Filters can be applied to the following requests:

A GET request on the Dashboard Results resource: returns data filtered by the specified parameters.
A PUT request on the Dashboard Results resource: refreshes the data that has been filtered by the specified parameters.
A GET request on the Dashboard Status resource: returns status for the data that has been filtered by the specified parameters.

Example Usage

A dashboard with one filter (“Country”) and two options (“United States” and “Canada”) appears like this in the dashboard metadata:

1{
2  "dashboardMetadata" : {
3    ...
4
5    "filters" : [ {
6        "name" : "Country",
7        "options" : [ {
8            "id" : "0ICxx0000000001GAA",
9            "alias" : "United States",
10            "operation" : "equals",
11            "value" : "US",
12            "startValue" : null,
13            "endValue" : null
14         } ], [ {
15            "id" : "0ICxx0000000002GAA",
16            "alias" : "Canada",
17            "operation" : "equals",
18            "value" : "CA",
19            "startValue" : null,
20            "endValue" : null
21         } ],
22
23    ...
24}

To retrieve dashboard results with a filter of “Country equals Canada” you could make the following GET request:

1/services/data/v31.0/analytics/dashboards/01Zxx0000000000000?filter1=0ICxx0000000002GAA

See Also