Update Dashboard Filters

The updateDashboardFilters mutation applies filter changes to a dashboard and updates all affected widgets.

Signature

updateDashboardFilters(id: String!, version: String, filterMutations: FilterMutationInput!): Dashboard!

Arguments

id · String! · required

The unique identifier of the dashboard to update filters for.

filterMutations · FilterMutationInput! · required

Filter mutation configuration specifying the changes to apply. See FilterMutationInput.

Response

Returns the updated Dashboard object with refreshed filter definitions. See Dashboard for the schema.

Usage Example

The following example shows how to apply filter changes to a dashboard:

mutation UpdateDashboardFilters($id: String!, $filterMutations: FilterMutationInput!) {
  updateDashboardFilters(id: $id, filterMutations: $filterMutations) {
    id
    filters {
      id
      parsedFilter {
        column
        value
      }
      appliedState {
        widgetId
        filterIdOnWidget
      }
    }
  }
}

Request

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <jwt_token>" \
  -d '{
    "query": "mutation UpdateDashboardFilters($id: String!, $filterMutations: FilterMutationInput!) { updateDashboardFilters(id: $id, filterMutations: $filterMutations) { id filters { id parsedFilter { column value } } } }",
    "variables": {
      "id": "dashboard_123456789",
      "filterMutations": {
        "addFilters": [
          {
            "column": "region",
            "value": "North America"
          }
        ]
      }
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql

Response

{
  "data": {
    "updateDashboardFilters": {
      "id": "dashboard_123456789",
      "filters": [
        {
          "id": "filter_987654321",
          "parsedFilter": {
            "column": "region",
            "value": "North America"
          }
        }
      ]
    }
  }
}

Related Operations

Dashboard Query

Retrieve dashboard with updated filters

DashboardFilterDefinition Object

Filter definition schema