Filter and Selection Syntax for Embedded Dashboards

Filter Syntax

Use this syntax for filtering on dimensions. Example values syntax for measures and dates for both filters and selections follow further down.

{"datasets" : {
    "dataset1": [
      {
        "fields": ["field1"], 
        "filter": { 
            "operator": "in", 
            "values": ["$value1", "$value2"]
          }
        }
      ]
    }
  }

In this example, the dashboard filters the account name on the record page and shows only data related to that account name.

{"datasets": {
    "account":[
      {
        "fields":["Name"], 
        "filter": {
          "operator": "matches", 
          "values":["$Name"]
          }
        }
      ]
    }
  }

Selection Syntax

With the selection option, the dashboard shows with all its data, and the specified dimension values are highlighted. The selection option can be used alone or with the filter option. Selection takes dimension values only. To use this option, the dashboard must include a query (step) of the specified id that groups by the specified group name. If a selection specifies a value that doesn't exist or if the query itself is unused (for instance, not attached to any widget), then the selection input is ignored and the dashboard appears with no selection applied.

{"steps" : {
    "Account_Step":  
      {
        "metadata": {"groups": ["Name"]}, 
        "values": ["$Name"]
      }
    }
  }

Additional Filter and Selection Syntax Examples

Use this syntax for filtering or selecting with measures values.

{
    ...
    "values": [[value1]]
    ...
  }

Use this syntax for filtering or selecting with relative date range values.

{
    ...
    "values": [["year", 0], ["year", 2]]
    ...
  }

Use this syntax for filtering or selecting with open-ended relative date range values.

{
    ...
    "values": [null, ["year", 2]]
    ...
  }

Use this syntax for filtering or selecting with absolute date range. Use epoch times for this range.

{
    ...
    "values": [[1581033600000, 1585353600000]]
    ...
  }

Syntax Reference Tables

Use these tables to understand the notation for the filters and selection syntax.