Retrieving Filters

Listing the Filters you can use with Mentions.

All Mention data calls can be filtered so that you can access specific parts of your data. You can do this by using Filters. Mentions can be filtered by many different values of metadata.

If you are building an application, we recommend caching the Filters that are applied to your Mentions locally, so that you do not have to retrieve them every time that you do a Mentions data call.

You can find out the metadata that Mentions can be filtered 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,
  "facebookAuthorId": null,
  "xfacebookAuthorId": null,
  "facebookRole": null,
  "xfacebookRole": null,
  "facebookSubtype": null,
  "xfacebookSubtype": null,
  "subtype": null,
  "xsubtype": null,
  "facebookCommentsMax": null,
  "facebookCommentsMin": null,
  "facebookLikesMax": null,
  "facebookLikesMin": null,
  "facebookSharesMax": null,
  "facebookSharesMin": 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
}

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

Retrieving Filters

Listing the Filters you can use with Mentions.