Available Filters

There are a number of filters which have been deprecated in the new Consumer Research API. Furthermore, we have changed the names of some of our page types. These changes can be found on the updated version of the Available Filters page.

These Filters can then be used as parameters in Mention or Data Retrieval calls. For example, you could pass the parameter gender="female" to only retrieve Mentions that were authored by females.

On this page we will show you:

Possible Filters

You can find out the metadata that you can filter by with the following call:

curl -X GET https://api.brandwatch.com/filters

The response will look like this:

{
  "queryId": null,
  "queryGroupId": null,
  "projectId": null,
  "startDate": null,
  "endDate": null,
  "sinceId": null,
  "untilId": null,
  "dayOfWeekTimezone": null,
  "hourOfDayTimezone": null,
  "search": null,
  "sinceAssignmentUpdated": null,
  "untilAssignmentUpdated": null,
  "author": null,
  "xauthor": null,
  "exactAuthor": null,
  "xexactAuthor": null,
  "authorGroup": null,
  "xauthorGroup": null,
  "sentiment": null,
  "pageType": null,
  "xpageType": null,
  "siteGroup": null,
  "xsiteGroup": null,
  "locationGroup": null,
  "xlocationGroup": null,
  "location": null,
  "xlocation": null,
  "authorLocationGroup": null,
  "xauthorLocationGroup": null,
  "authorLocation": null,
  "xauthorLocation": null,
  "category": null,
  "xcategory": null,
  "parentCategory": null,
  "xparentCategory": null,
  "tag": null,
  "xtag": null,
  "status": null,
  "xstatus": null,
  "priority": null,
  "xpriority": null,
  "checked": null,
  "starred": null,
  "assigned": null,
  "xassigned": null,
  "backlinksMax": null,
  "backlinksMin": null,
  "blogCommentsMax": null,
  "blogCommentsMin": null,
  "pagesPerVisitMax": null,
  "pagesPerVisitMin": null,
  "averageVisitsMax": null,
  "averageVisitsMin": null,
  "monthlyVisitorsMax": null,
  "monthlyVisitorsMin": null,
  "percentFemaleVisitorsMin": null,
  "percentMaleVisitorsMin": null,
  "averageDurationOfVisitMax": null,
  "averageDurationOfVisitMin": null,
  "twitterFollowersMax": null,
  "twitterFollowersMin": null,
  "twitterFollowingMax": null,
  "twitterFollowingMin": null,
  "twitterReplyTo": null,
  "xtwitterReplyTo": null,
  "twitterRetweetOf": null,
  "xtwitterRetweetOf": null,
  "twitterPostCountMax": null,
  "twitterPostCountMin": null,
  "twitterRetweetsMax": null,
  "twitterRetweetsMin": null,
  "forumPostsMax": null,
  "forumPostsMin": null,
  "forumViewsMax": null,
  "forumViewsMin": null,
  "mozRankMax": null,
  "mozRankMin": null,
  "reachMin": null,
  "reachMax": null,
  "influenceMin": null,
  "influenceMax": null,
  "outreachMin": null,
  "outreachMax": null,
  "language": null,
  "xlanguage": null,
  "domain": null,
  "xdomain": null,
  "subtype": null,
  "xsubtype": null,
  "twitterVerified": null,
  "twitterRole": null,
  "twitterAuthorId": null,
  "xtwitterAuthorId": null,
  "impressionsMax": null,
  "impressionsMin": null,
  "impactMax": null,
  "impactMin": null,
  "instagramFollowersMax": null,
  "instagramFollowersMin": null,
  "instagramFollowingMax": null,
  "instagramFollowingMin": null,
  "instagramPostsMax": null,
  "instagramPostsMin": null,
  "instagramLikesMax": null,
  "instagramLikesMin": null,
  "instagramCommentsMax": null,
  "instagramCommentsMin": null,
  "instagramInteractionsMax": null,
  "instagramInteractionsMin": null,
  "threadId": null,
  "xthreadId": null,
  "threadEntryType": null,
  "xthreadEntryType": null,
  "threadAuthor": null,
  "xthreadAuthor": null,
  "postByAuthor": null,
  "xpostByAuthor": null,
  "shareOfAuthor": null,
  "xshareOfAuthor": null,
  "replyToAuthor": null,
  "xreplyToAuthor": null,
  "resourceType": null,
  "xresourceType": null,
  "editorialValueEURMin": null,
  "editorialValueEURMax": null,
  "editorialValueUSDMin": null,
  "editorialValueUSDMax": null,
  "editorialValueGBPMin": null,
  "editorialValueGBPMax": null,
  "insightsEmoticon": null,
  "insightsHashtag": null,
  "insightsMentioned": null,
  "insightsUrl": null,
  "xinsightsEmoticon": null,
  "xinsightsHashtag": null,
  "xinsightsMentioned": null,
  "xinsightsUrl": null,
  "gender": null,
  "accountType": null,
  "profession": null,
  "xprofession": null,
  "interest": null,
  "xinterest": null,
  "exclusiveLocation": null,
  "hourOfDay": null,
  "dayOfWeek": null,
  "geolocated": null,
  "latitudeMin": null,
  "latitudeMax": null,
  "longitudeMin": null,
  "longitudeMax": null,
  "mentionId": null
}

Accepted Values for Global Preset Metrics

Some of these Filters are actually global preset metrics, with a limited set of acceptable values. The below call will give you those presets and their corresponding accepted values:

curl -X GET https://api.brandwatch.com/metrics

This returns (at the time of writing):

{
  "sentiments": [
    "negative",
    "neutral",
    "positive"
  ],
  "accountTypes": [
    "organisational",
    "individual"
  ],
  "genders": [
    "female",
    "male"
  ],
  "pageTypes": [
    "news",
    "forum",
    "general",
    "image",
    "twitter",
    "review",
    "facebook",
    "video",
    "instagram",
    "blog"
  ],
  "subTypes": [
    "other",
    "question",
    "link",
    "photo",
    "video",
    "status"
  ]
}

As we add new global metrics, they will turn up here. It's worth mentioning that these change infrequently, often in line with new features being added to Analytics. If you wanted to store these locally and update them in your app infrequently, then you could take that approach and save on your rate limiting.