Need a special offer?Find out if your project fits.
+
All documentation
API reference
  • API Reference for older versions
  • FilterGroupObject

    The FilterGroupObject describes filters for hierarchical data. When the server supports multilevel hierarchies, the FilterGroupObject appears in the /members request and the /select requests for the pivot table, the flat table, and the drill-through view.

    Refer to our guide to learn more about supporting multilevel hierarchies.

    Properties

    {
      "type": string,
      "value": FilterObject[] | FilterGroupObject[]
    }
    Property/Type Description
    type
    String
    The filter's type. Possible values: "and", "or".
    value
    FilterObject[] | FilterGroupObject[]
    Filters to apply to the data. Filters are combined using the operator specified in the type property.

    Examples

    The code below demonstrates the request with the FilterGroupObject. Notice that the filter.value array contains two objects: the first one is a FilterGroupObject, and the second one is a FilterObject.

    {
      "type": "and",
      "value": [
        {
          "type": "or",
          "value": [
            {
              "field": {
                "uniqueName": "country"
              },
              "query": {
                "begin": "c"
              }
            },
            {
              "field": {
                "uniqueName": "state"
              },
              "query": {
                "begin": "c"
              }
            }
          ]
        },
        {
          "field": {
            "uniqueName": "W"
          },
          "query": {
            "begin": "m"
          }
        }
      ]
    } 

    See also

    Supporting multilevel hierarchies
    FilterObject
    /members request
    /select request for pivot table
    /select request for flat table
    /select request for drill-through view