In most of the endpoints you can set filters to slice and dice the scope of data you are interested in. The values you can pass are the same ones you can see on the Wonderboard.

Please refer to each endpoint documentation for the specific filters available.

​
Single Attribute Filter

To filter by a single attribute pass the attribute name as “name” and the desired value as “values”.

Here’s the schema detail and some examples:

An array of single multiple values is also supported:

​
Multiple attribute filter

​
Filter intersection (AND)

For scenarios where you need to filter on multiple attributes, such as “rating” and “channel”, you can pass multiple filter objects.

In this example, the API will return all the feedback with rating 1 AND collected from amazon.com:

filters: [{ 
    "name": "rating",
    "values": 1 
  }, { 
    "name": "channel", 
    "values": "amazon.com" 
}]

​
Filter Union (OR)

You also can filter by multiple values of the same attribute by simply adding the same object twice with different value. The data in this case is returned in OR as the two filter have the same name.

In this example, the API will return all the feedback with rating 1 OR 2.

{ "name": "rating", "values": [1, 2] }

Filter values

To see the available values for the feedback in a given scope the best way is to check the data in the Wonderboard analytics (e.g. Overall section) and see the list of values in the menu.

​
Special filters

​
Topic filter

The filter by topic, follows a similar syntax but slightly different rules. In fact, you can couple it with another filter called “sentiment” to retrieve all the feedback records about a topic with a given sentiment. Here’s an example of applying filters for the topic “Design” and sentiment 1:

filters: [
  { "name": "topic", "values": "Design" }, 
  { "name": "sentiment", "values": 1 }
]

This returns all the feedback containing the topic design with a positive sentiment.

The sentiment filter accepts the following values:

1 = Positive

0 = Negative

0.5 Neutral

You can combine more than one topic in a query as Union.

filters: [
  { "name": "topic", "values": ["Design","Performance"] }
]

This will return all the reviews that mention Performance or Design

Current limitation

At the moment, it is not possible to filter by two topics using the AND (intersection) syntax.

If you apply a sentiment filter to two topics using OR logic, you can only select one sentiment filter:

This means that the selected sentiment filter will be applied to both topics. Currently, it is not possible to filter for two different topics with opposite sentiments.

So, in the example above of multiple sentiment, the API will return all reviews with topic Design OR Performance AND with sentiment positive OR negative.

​
Date filter

When filtering by date ranges, use two-element array [“from”, “to”], despite it being an exception to the general syntax. In this case, “name” is set to publishedByUserAt and “values” is an array with the start and end dates.

Here’s an example filtering user publications from December 13, 2024 to December 15, 2024:

The supported date format is YYYY/MM/DD

User managementPagination