Listening Analytics Options
The API supports a number of pre-defined analysis options, plus the ability to specify a custom analysis using the supported dimensions and measures listed below.
To learn more about requesting analytics see the Analyzing Earned Media guide.
Please note that:
- For X use
twitteras the source name in analytics requests. - Output for News documents is subject to copyright restrictions.
Pre-defined analytics
This table summarizes the pre-defined analytics supported by the Meltwater API.
| Analysis Type | Description | Endpoint | Sources |
|---|---|---|---|
| Total volume | Overall number of mentions for the search, plus average per day and per hour | /v3/analytics/{searchId} | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Daily/hourly volume | Daily and hourly breakdown of mentions volume | /v3/analytics/{searchId} | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Top countries | Most frequent countries for authors of mentions / content | /v3/analytics/{searchId} | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuBroadcast |
| Top languages | Most frequent languages for mentions / content | /v3/analytics/{searchId} | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Sentiment | Discrete sentiment breakdown of mentions / content | /v3/analytics/{searchId} | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Top shared links | The links shared most in content that matches your search | /v3/analytics/{searchId}/top_shared_links | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatBilibiliYoukuTikTokBroadcast |
| Top keyphrases | Most frequent key phrases that appear in the mentions / content | /v3/analytics/{searchId}/top_keyphrases | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Top topics | Most frequent topics that appear in the mentions / content | /v3/analytics/{searchId}/top_topics | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Top locations | Most frequent locations (country, state, city) of authors in the analyzed content | /v3/analytics/{searchId}/top_locations | NewsXBlogsForumsRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuBroadcast |
| Top entities | Most frequent entities that appear in the analyzed content | /v3/analytics/{searchId}/top_entities | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTokBroadcast |
| Top tags | Most frequent hashtags that appear in the analyzed content | /v3/analytics/{searchId}/top_tags | XFacebookInstagramTikTok |
| Top mentions | Most frequent social handles that appear in the analyzed content | /v3/analytics/{searchId}/top_mentions | XFacebookInstagramTikTokBroadcast |
| Top shared | The most 'shared' content matching the search | /v3/analytics/{searchId}/top_shared | X |
| Top sources | Top (most frequent) authors of the content | /v3/analytics/{searchId}/top_sources | X |
Custom analytics
Dimensions
| Dimension | Description | Example Values | Sources |
|---|---|---|---|
author_handle | Handle of the document's author | @john_smith | FacebookRedditBlogsCommentsTwitchPinterestBilibiliDouyinWeiboWeChatYoukuLineVoomKakaoTalkTikTok |
author_name | Name of the document's author | John Smith | NewsRSSBlogsCommentsForumsFacebookRedditTwitchPinterestBilibiliDouyinWeiboWeChatYoukuLineVoomKakaoTalk |
discussion_type | The type of document relating to discussion | Reply, Original Post, Repost, Quote and Comments | YoukuWeChatXSina WeiboRedditREDLineVoomKakaoTalkInstagramForumsCommentsBilibiliTikTok |
editorial_source_name | For news sources only - the name of the source | Washington Post | NewsRSS |
emotion | Detected emotion in the document | Happy, Disgust, Love | WeChatXSina WeiboReviewsRedditPinterestNewsREDLineVoomKakaoTalkInstagramForumsCommentsDouyinBilibiliTikTokBroadcast |
entity_name | The names of entities detected in the content | Emerging Technologies, Microsoft, Joe Biden | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
entity_type | The types of entities detected in the content | organization, person | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
event_type | The types of event related to a company detected in the content | Civil Law, Executive Appointment | News |
hashtag | Hashtags that appear in the document's content | ai, football | InstagramBlogsYouTubeTwitchPinterestBilibiliDouyinREDWeiboLineVoomTikTok |
keyphrase | Keyphrases found within the document content | artificial intelligence, tesla | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
language | Language detected for the document | English, French, German | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
location_city | City where the document was published | Berlin | NewsXFacebookWeiboBroadcast |
location_country | Country where the document was published | United Kingdom, South Korea | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomBroadcast |
location_state | State where the document was published | California | NewsXFacebookDouyinWeiboBroadcast |
media_type | The media type of the document | News Article, Reddit Post/Comment | FacebookRSSYoukuWeChatTwitchXSina WeiboReviewsRedditPinterestNewsREDLineVoomKakaoTalkInstagramForumsCommentsBlogsBilibiliDouyinTikTokBroadcast |
mention | Social media handles mentioned in the document | meltwater | InstagramXTikTok |
sentiment | Sentiment of the document or mention | positive, negative, neutral, unknown | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
shared_link | Links shared within articles and posts | http://www.newsite.com/link/to/article | NewsXFacebookInstagramRedditBlogsForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuTikTok |
social_source_name | For social sources only - the name of the source | Reddit, X | BlogsCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTok |
source | Source of the document - called 'Source Type' in Explore | News, Reddit, Facebook | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
source_name | The name of the source of the document | Washington Post, Reddit, Facebook | NewsRSSXFacebookInstagramRedditForumsTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
source_url | The url of the source of the document | https://nytimes.com | NewsRSSCommentsReviewsForumsXFacebookInstagramRedditTwitchPinterestDouyinWeChatREDBilibiliYoukuKakaoTalkLineVoomTikTokBroadcast |
verified_type | The verification type of the document author | Individual, Government, None | XSina Weibo |
Measures
| Measure | Description | Example Values | Sources |
|---|---|---|---|
engagement | Total engagement for articles and posts across news and social, such as social echo for news, and shares and reports of social | 2459 | NewsXFacebookInstagramForumsBlogsCommentsPinterestBilibiliDouyinREDWeiboLineVoomTikTok |
estimated_views | Number of estimated views of the news article, based on the reach of the source | 3965 | News |
reach | Reach for the document, for example number of followers for social authors, or estimate of number of visitors for a news site | 1259 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalkTikTokBroadcast |
social_echo | Number of times an article has been shared on social networks | 12.68 | News |
social_echo_facebook | Number of times an article has been shared on Facebook | 72.7 | News |
social_echo_reddit | Number of times an article has been shared on Reddit | 2.09 | News |
social_echo_x | Number of times an article has been shared on X | 17.04 | News |
social_engagement_likes | Number of likes on a social post | 8457 | BlogsXFacebookTikTok |
social_engagement_reactions | Number of reactions on a social post | 9599 | BlogsXFacebookInstagramRedditDouyinREDBilibiliKakaoTalkLineVoomTikTok |
social_engagement_replies | Number of replies on a social post | 2233 | BlogsXFacebookTikTok |
social_engagement_shares | Number of shares on a social post | 50442 | FacebookPinterestKakaoTalkLineVoomTikTok |
views | Number of views of the social post | 10045 | XTwitchBilibiliYoukuTikTok |