Get Free Trial
API reference
Table of contents

FilterGroupObject

The FilterGroupObject describes filters for hierarchical data. It appears in /members and /select requests when the server supports multilevel hierarchies.

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

The FilterGroupObject has the following parameters:

  • type – String. The filter’s type. Possible values: "and", "or".
  • value – Array of objects. Filters to apply to the data. Each element in the array can be either the FilterObject or the FilterGroupObject. 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