Describes filtering parameters that are wrapped in an array, URL-encoded, and passed in with GET requests using the filterParams query parameter.
Sample non-encoded parameter value, expanded:
[
{
"condition": "in",
"id": 4,
"type": "dimension",
"values": [
"GB"
]
},
{
"condition": "gt",
"id": 155,
"type": "metric",
"values": [
16
]
}
]
FilterParams members
| Member | Type | Required | Description |
|---|---|---|---|
FilterParams | |||
condition | Enumeration | ✓ | The condition specifier. For dimensions: in, nin (in or not in), contains, ncontains (does or doesn't contain), starts, nstarts (does or doesn't start with), ends, nends (does or doesn't end with). For metrics: eq, neq (equal or not), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). |
id | Integer | ✓ | Identifies each dimension or metric filtering entity. |
type | Enumeration | ✓ | Specifies whether the provided id parameter is a dimension or a metric. |
values | Array | ✓ | List of values used to filter the result. Values represent either inclusions or exclusions, depending on what the condition parameter specifies. |