Mention Field Definitions

A guide to the metadata fields attached to each mention

FieldDefinitionPossible Values
accountTypeAccount Type is the type of account ('individual' or 'organisational') that a Twitter author has. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, "individual", "organisational"
addedAdded is the date when the mention was added to the Brandwatch query (either by regular crawling or a backfill).string
assignmentAssignment is part of the Brandwatch workflow functionality and allows you to send a mention to another Brandwatch user to check.null, or the email address (string) of a User with access to the given Project
authorAuthor is the nick name, user name or full name of the person who posted a mention. The name depends on the site on which it has been found."", or the author (string) of the mention
authorCityDeprecated
authorCityCodeDeprecated
authorContinentDeprecated
authorContinentCodeDeprecated
authorCountryDeprecated
authorCountryCodeDeprecated
authorCountyDeprecated
authorCountyCodeDeprecated
authorLocationDeprecated
authorStateDeprecated
authorStateCodeDeprecated
avatarUrlAvatar URL is the URL of the author's Twitter avatar. This is only available for mentions originating from Facebook, Instagram or Twitter.null, or the URL (string) of the author's avatar
averageDurationOfVisitDeprecated
averageVisitsDeprecated
backlinksDeprecated
blogCommentsDeprecated
blogNameName of the Tumblr page.null or string
categoriesCategories is an array of IDs of any categories that are applied to the mention.Empty array, or a array of category IDs (int)
categoryDetailsCategory Details is an array of details (ID of the category, name of the category, ID of the parent category, name of the parent category) for each of the categories that is applied to the mention.Empty array, or an array of objects with details about each Category. These objects would each be in the format: {id: int, name: string, parentId: int, parentName: string}
checkedChecked is part of the Brandwatch workflow functionality and can be used to indicate that a mention has been reviewed.TRUE, FALSE
cityCity is the name of the city from which the mention originated.null, or the city name (string)
cityCodeCity Code is the shortcode for the city from which the mention originated.null, or the city code (string) (e.g. "bos1")
classificationsClassifications is an array of details (ID of the classifier, ID of the classification, name of the classification, ID of the training set and the confidence score of the classification) for each classification that is applied to the Mention.Omitted if empty or an array of objects with details of each classification.
continentContinent is the name of the continent from which the mention originated.null, or the continent name (string)
continentCodeContinent Code is the shortcode for the continent from which the mention originated.null, or the continent code (string) (e.g. "n-a")
copyrightCopyright information for a Lexis Nexis mentionstring
countryCountry is the name of the country from which the mention originated.null, or the country name (string)
countryCodeCountry Code is the shortcode for the country from which the mention originated.null, or the country code (string) (e.g. "us")
countyDeprecatedAlternative: region
countyCodeDeprecatedAlternative: regionCode
dateDate is the date when the mention was posted."YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"
displayUrlsDisplay URLs are the shortened links that appear in a mention. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, empty array, or a list of the shortened URLs (string)
domainDomain is the domain name of the website from which the mention originated.domain (string) that the mention originated from
engagementDeprecatednull or int
entityInfoAn array of details describing entities (AI terms) found in the Mention text.

"entityId": an integer number/identifier for the WikiData item associated with an entity

"entityConfidence": An indication of how confident the AI engine is that it has found the correct match on WikiData (HIGH, MEDIUM, LOW, VERY_LOW)

"url": Link to the WikiData entry describing the entity
Empty array or an array containing: "entityId", "entityConfidence" and "url".
expandedUrlsDisplay URLs are the full URLs for any shortened links that appear in a mention. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, empty list, or a list of the expanded URLs (string)
facebookAuthorIdFacebook Author Id is the unique id of the Facebook author. This is a Facebook specific metric, and will be null for mentions not originating from Facebook.null, or the author id (string)
facebookCommentsFacebook Comments is the number of comments on a Facebook mention. This is a Facebook specific metric, and will be 0 for mentions not originating from Facebook.0, or a positive integer
facebookLikesFacebook Likes is the number of Likes on a Facebook mention. This is a Facebook specific metric, and will be 0 for mentions not originating from Facebook.0, or a positive integer
facebookRoleFacebook Role is the role of the Facebook user who authored the post ('owner' or 'audience'). A Facebook role of 'owner' would indicate that the author is posting on their own page, whereas a Facebook role of 'audience' would indicate that an author is posting on someone else's Facebook page. This is a Facebook specific metric, and will be null for mentions not originating from Facebook.null, "owner", "audience"
facebookSharesFacebook Shares is number of times that a Facebook mention has been shared. This is a Facebook specific metric, and will be 0 for mentions not originating from Facebook.0, or a positive integer
facebookSubtypeFacebook Subtype is the type of media shared in a Facebook mention ('link', 'photo', 'status' or 'video'). This is equivalent to the Facebook Media Type shown in the front end of the Brandwatch Analytics platform. This is a Facebook specific metric, and will be null for mentions not originating from Facebook.null, "link", "photo", "status", "video"
forumPostsDeprecated
forumViewsDeprecated0, or a positive integer
fullnameFull Name is the full name of the author who posted the mention.null, or author's full name (string)
genderGender is the gender ('male', 'female', 'unknown') of an author. This is a Twitter specific metric, and will be 'unknown' for mentions not originating from Twitter."male", "female", "unknown"
idDeprecated
imageInfoAn array of details (URL of image, dimensions of image, dominant color of image, objects found in image, and scenes found in image) of the image analysis done on an image in a Mention.

Additional information for image object and scene IDs can be found by using endpoints in the Objects & Logos article.
Empty array or array of details of image analysis
impactImpact is a Brandwatch metric to measure the potential impact of an author, site or mention. It's a logarithmic scale between 0-100 normalised for your data to help you find what's most interesting. The impact score takes into account how much potential a mention has to be seen, as well as how many times a mention has been viewed, shared or retweeted.A decimal from 0-100
importanceAmplificationInternally used to calculate the Impact Score.0, or a positive integer
importanceReachInternally used to calculate the Reach Score.0, or a positive integer
impressionsImpressions is the potential number of viewers of a tweet. This is calculated by taking the sum of the followers of the account that originally posted a tweet, and the followers of any accounts that retweeted it. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
influenceDeprecated
insightsHashtagInsights Hashtags is an array of hashtags identified within the mention. This is a Twitter and Instagram specific metric, and will be empty for mentions not originating from Twitter or Instagram.Empty array, or array of strings
insightsMentionedInsights Mentioned is an array of user handles identified within the mention. This is a Twitter and Instagram specific metric, and will be empty for mentions not originating from Twitter or Instagram.Empty array, or array of strings
instagramCommentCountInstagram Comment Count is the number of comments on an Instagram mention. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
instagramFollowerCountInstagram Followers Count is the number of followers of the Instagram mention's author. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
instagramFollowingCountInstagram Following Count is the number of users that the author of an Instagram mention is following. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
instagramInteractionsCountInstagram Interactions Count is the sum of likes and posts on an Instagram mention. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
instagramLikeCountInstagram Like Count is the number of likes on an Instagram mention. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
instagramPostCountInstagram Post Count is the overall number of posts the author of an Instagram mention has made. This is an Instagram specific metric, and will be 0 for mentions not originating from Instagram.0, or a positive integer
interestInterest is an array of the interests that are mentioned in the Twitter bio of the individual (not organization) that authored the mention. This is a Twitter specific metric, and will be an empty list for mentions not originating from Twitter.Empty array, or an array of interests. All possible interests are: "Animals & Pets", "Fine arts", "Automotive", "Beauty/Health & Fitness", "Books", "Business", "Environment", "Family & Parenting", "Fashion", "Movies", "Food & Drinks", "Games", "Music", "Photo & Video", "Politics", "Science", "Shopping", "Sports", "Technology", "Travel", "TV"
itemReviewThe item being reviewed in a review mentionnull or string
languageLanguage is the shortcode for the language in which the mention was written.Shortcode for the language (string) (e.g."en")
lastAssignmentDateLast Assignment Date is part of the Brandwatch workflow functionality and shows the date when the mention was last assigned to a Brandwatch user. If the mention has never been assigned to a user, this field will be null.null, or "YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"
latitudeLatitude of a geo-tagged Tweet. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter as well as mentions that have not been goe-tagged.float
linkedinCommentsNumber of comments on a LinkedIn mention. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedIn.int
linkedinEngagementNumber of likes, comments, clicks & shares divided by the number of impressions for a LinkedIn mention. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedIn.float
linkedinImpressionsNumber of impressions on a LinkedIn mention. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedIn.int
linkedinLikesNumber of likes on a LinkedIn mention. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedInint
linkedinSharesNumber of times a LinkedIn mention has been shared. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedIn.int
linkedinSponsoredWhether the LinkedIn post is sponsored or organicstring; 'sponsored' or 'organic'
linkedinVideoViewsNumber of times a user has viewed a LinkedIn video for longer than 3 seconds. This is a LinkedIn specific metric and will be 0 for mentions not originating from LinkedIn.int
locationNameLocation name of a geo-tagged Instagram mentions. This is an Instagram specific metric, and will be null for mentions not originating from Instagram as well as mentions that have not been geo-tagged.null, or string
longitudeLongitude of a geo-tagged Tweet. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter as well as mentions that have not been geo-tagged.float
matchPositionsMatch Positions is an array of details about words from the mention that matched the query string.Array of objects in the following format: {length: int, start: int, text: string}
mediaFilterMedia Filter is the image filter that was used on an Instagram mention. This is an Instagram specific metric, and will be null for mentions not originating from Instagram.null, or the filter (string) used on the Instagram mention
mediaUrlsMedia URLs is a list of the URLs associated with any media (e.g. photo, video) attached to the mention.null, empty list, or a list of URLs (string)
monthlyVisitorsMonthly Visitors is a metric pertaining to the traffic for the site that the mention originated from. It is the total number of unique visitors who have been to the website that month.0, or a positive integer
mozRankDeprecated
noteIdsDeprecated
originalUrlOriginal URL is the URL of the tweet. If the tweet is a retweet or a reply it will be the URL of the original being retweeted or replied to. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, or the URL (string) of the original tweet
outreachDeprecated
pageTypeNameDescribes the kind of website the mention was found on in a more human-readable way."Blogs", "YouTube", "Dark Web", "QQ", "Facebook", "Tumblr", "Instagram", "Forums", "Twitter", "VK", "Review", "Sina Weibo", "Reddit", "4Chan", "LexisNexis Licensed News", "News"
pagesPerVisitDeprecated
parentPostIdThe unique ID of the parent post on Tumblr. Used to track reblogs of a specific post from a specific page on Tumblr and reblogs of those.null or int
parentBlogNameName of the parent page on Tumblr. Used to track content reblogged from a specific Tumblr page.null or string
percentFemaleVisitorsDeprecated
percentMaleVisitorsDeprecated
priorityPriority is part of the Brandwatch workflow functionality and can be used to indicate the priority of a mention (e.g. 'high', 'medium', 'low'). If the mention has never been marked with a priority, this field will be null.null, "n/a", "low", "medium", "high"
professionsProfession is an array of the professions that are mentioned in the Twitter bio of the individual (not organization) that authored the mention. This is a Twitter specific metric, and will be an empty list for mentions not originating from Twitter.Empty array, or an array of professions. All possible professions are: "Artist", "Executive", "Health practitioner", "Journalist", "Legal", "Politician", "Sales/Marketing/PR", "Scientist & Researcher", "Software developer & IT", "Sportpersons & Trainer", "Student", "Teacher & Lecturer"
pubTypeName of the publisher of content source or the user-defined name of the custom content source.string
publisherSubTypeA publisher-defined subtypenull or string (i.e "IMAGE" is an Instagram-defined subtype)
queryIdQuery Id is the unique identifier for the query that the mention originated from in Brandwatch.int
queryNameQuery Name is the name of the query that the mention originated from in Brandwatch.string
ratingStar review rating for review mentionsnull or int 1-5
reachDeprecated
reachEstimateReach Estimate is a score created by Brandwatch to estimate how many individuals may have seen a piece of content. It's available for multiple data sources and enables the user to compare reach of content from different platforms and track development over time.0, or a positive integer
redditAuthorKarmaThe author's total karma at the time the post/comment was created. For more information on Karma see here. Only available on Reddit mentions.null, or a long
redditAuthorAwardeeKarmaThe author's karma from receiving awards from other users at the time the post/comment was created. For more information on Karma see here. Only available on Reddit mentions.null, or a long
redditAuthorAwarderKarmaThe author's karma from giving awards to other users at the time the post/comment was created. For more information on Karma see here. Only available on Reddit mentions.null, or a long
redditCommentsReddit Comments is the number of comments on a reddit post. This is a Reddit specific metric, and will be 0 for mentions not originating from Reddit. This value may not exactly reflect what is shown in the Reddit UI due to the way Reddit supply the data.0, or a positive number
redditScoreNet votes on a reddit post or comment. Number of upvotes minus the number of downvotes. Updated hourly for a period of 7 days from the time it was initially posted. This value may not exactly reflect what is shown in the Reddit UI due to the way Reddit supply the data.null, an integer
redditScoreUpvoteRatioThe portion of votes on a message which are upvotes, expressed as a ratio between 0.0 and 1.0. Only available for Reddit Posts, not comments. This value may not exactly reflect what is shown in the Reddit UI due to the way Reddit supply the data.null, or a float between 0.0 and 1.0
regionRegion is the name of the region from which the mention originated.null, or the region name (string) (e.g "Alaska")
regionCodeRegion code is the code of the region from which the mention originatednull, or the region code (string) (e.g "USA.AK")
replyToReply To is the URL of the original tweet that this tweet is in reply to. This is a Twitter specific metric, and will be null for mentions not originating from Twitter and for tweets that are not a reply to any earlier tweet.null, or the URL (string) of the original tweet
resourceIdResource Id is the unique identifier assigned to a mention when it is indexed in our database. This is for reference when using the Brandwatch API.string
resourceTypeSoon to be removednull or string
retweetOfRetweet Of is the URL of the original tweet that this tweet is a retweet of. This is a Twitter specific metric, and will be null for mentions not originating from Twitter and for tweets that are not a retweet of any earlier tweet.null, or the URL (string) of the original tweet
rootPostIdUnique ID of the root Tumblr mention. Used to track reblogs of a specific post on Tumblr as well as reblogs of those.null or int
rootBlogNameName of the root Tumblr page. Used to track mentions reblogged from a specific page and reblogs of that same content on Tumblr.null or string
sentimentSentiment is the tone of the mention: positive, negative or neutral."positive", "negative", "neutral"
shortUrlsShort URLs are the shortened links that appear in a mention. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, empty array, or an array of the shortened URLs (string)
snippetSnippet is a snippet of the mention text that best matches the query.string
starredStarred is part of the Brandwatch workflow functionality and can be used to indicate that a mention is interesting, or to mark it for any other purpose you choose.TRUE, FALSE
stateDeprecatedAlternative: region
stateCodeDeprecatedAlternative: regionCode
statusStatus is part of the Brandwatch workflow functionality and can be used to indicate the status of a mention (e.g. 'open', 'pending', 'closed'). If the mention has never been marked with a status, this field will be null.null, "open", "pending", "closed"
subredditThe subreddit that the post or comment belongs to. For more information on Subreddits, see here. Only available on Reddit mentions.null, or a string
subredditSubscribersThe number of subscribers to the subreddit which the post/comment belongs to, at the time the post/comment was created. Only available on Reddit mentions.null, or a non-negative long
subtypeSubtype is the same as the Media Type in the UI, and indicates the type of media included within a Facebook, Twitter, or Instagram mention.null, "photo", "video", "other", "question", "link", "status"
tagsTags is an array of the names of any tags that are applied to the mention.Empty array, or an array of tag names (string)
threadAuthorThread Author is the name of the author of the original mention in the thread.null, or the author name (string)
threadCreatedThread Created is the date when the original mention in the thread was posted.null, or "YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"
threadEntryTypeThread Entry Type is the type of mention (post, reply, share) for mentions in a thread.null, "reply", "post", "share"
threadIdThread Id is the unique identifier of the thread, (as provided by Twitter or Facebook)."0", or a the thread id (string)
threadURLThread URL is the URL of the full thread which this mention appears in.null, or the URL (string) of the thread
titleTitle is the title of the mention, as determined by Brandwatch.string
trackedLinkClicksDeprecatednull
trackedLinksDeprecatednull
twitterAuthorIdTwitter Author Id is the unique id of the Twitter author. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, or a string
twitterFollowersTwitter Followers is the number of followers of the Twitter mention's author. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
twitterFollowingTwitter Following is the number of users that the author of a Twitter mention is following. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
twitterLikeCountThe number of likes a tweet has received. This metric is updated once per hour so will lag behind what is reflected in the Twitter UI. Tweets posted before Brandwatch started collecting like data will have a null value.null, or a positive long
twitterPostCountTwitter Post Count is the total number of tweets that the author of the mention has posted. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
twitterReplyCountTwitter Reply Count is the total number of replies to a tweet. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
twitterRetweetsTwitter Retweet Count is the total number of times that a tweet has been retweeted. This is a Twitter specific metric, and will be 0 for mentions not originating from Twitter.0, or a positive integer
twitterRoleTwitter Role is the role of the Twitter user who authored the post ('owner' or 'audience'). A Twitter role of 'owner' would indicate that the author is posting on their own channel, whereas a Twitter role of 'audience' would indicate that an author is posting on someone else's channel. This is a Twitter specific metric, and will be null for mentions not originating from Twitter.null, "owner", "audience"
twitterVerifiedTwitter Verified indicates if the author of the mention is verified on Twitter (These are large accounts, usually celebrities). This is a Twitter specific metric, and will be false for all mentions not originating from Twitter.TRUE, FALSE
updatedUpdated is the date when the mention was last modified.string
urlURL is the URL of the mention.string
weblogTitleName or ID of the specific Reddit or forum author"", string or int (id of author)
wordCountDeprecatednull