A filter
is an object that contains filtering information. Here is a list of all available properties for a filter
:
query
optional – QueryObject. Conditional filter to apply to the hierarchy. Available properties for the QueryObject depend on the hierarchy type:
ValueQueryObject describes the filter on values.
members
optional – Array of strings. The hierarchy’s members to be reflected/shown. Must not be used together with query
. Example: { "members": ["country.[united states]"] }
.members
filter does not apply to a field with one member.exclude
optional – Array of strings. The hierarchy’s members to be excluded/hidden. Can be used together with query
. Example: { "exclude": ["country.[united states]"] }
.exclude
filter does not apply to a field with one member.include
optional – Array of strings. The hierarchy’s members to be reflected/shown in addition to the results returned by query
. Can be used for Number/String/Date/TimeQueryObjects. Example: { "include": ["country.[united states]"] }
.include
filter does not apply to a field with one member.measure
optional – Object. Refers to the filter on values. Identifies the measure on which the ValueQueryObject will be applied. measure
has two properties:
uniqueName
– String. The measure’s unique name.aggregation
optional – String. The measure’s aggregation type.