API reference
Table of contents

MemberObject

The object describes a field member to include or exclude in the filter.

Available parameters

{
  "member": string | number,
  "filter": FilterObject
}
Parameter/Type Description
member
String | Number
The field's member. For string field type it is string. For number and date field types it is number.
filter
FilterObject
optional Allows filtering multilevel hierarchies. If the member is a parent level of the hierarchy, specify filter to filter the lower levels of the hierarchy. Otherwise, the filter property is not necessary.

Examples

Example of the "query" with a selection filter, which is an array of MemberObjects:

"query": {
  "filter": [
    {
      "field": {
        "uniqueName": "color"
      },
      "include": [
        {
          "member": "blue"
        }
      ]
    },
    {
      "field": {
        "uniqueName": "city"
      },
      "exclude": [
        {
          "member": "New York"
        },
        {
          "member": "Montreal"
        }
      ]
    }
  ],
  "aggs": {
    "values": [
      {
        "func": "sum",
        "field": {
          "uniqueName": "price"
        }
      }
    ],
    "by": {
      "rows": [
        {
          "uniqueName": "city"
        }
      ]
    }
  }
}

See also

FilterObject
FilterGroupObject
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view