Legacy JSON Template
Deprecated
This is the JSON output you receive from a Listening API export or stream when no template field is specified on the request. For new integrations, use API JSON instead.
At a glance
| Template code | (default when no template is specified) |
| Output format | JSON |
| Supported endpoints | Listening API exports, Listening API streaming |
| Streaming support | Yes |
Important notes
- Country is rarely populated for Blogs and Comments.
See Conventions for behaviour shared across all templates.
Field reference
| Field | Path | Description | Type | Example | Sources |
|---|---|---|---|---|---|
| Export Metadata — These fields provide details of the export that was executed | |||||
| Search / Tag | metadata.search_name, metadata.search_id, metadata.tag_name | Save search (name / id) used for export, OR tag used for export | string | "My Brand Search" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Company ID | metadata.company_id | Meltwater identifier for the company/customer who ran the export | string | "58d5...abcd" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Document Metadata — These fields provide high-level details for documents, such as the source / provider | |||||
| Source | source_name | News publication, or social network | string | "Washington Post" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Source Type | source_information_type | Type of source | string | "social,news" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Source ID | source_id | Meltwater identifier for the source | string | "8065E3EF286CC963F0F0B5587A8D930C" | NewsXFacebookInstagramRedditBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Document Media Type | document_media_type | The media type of the document | string | "audio, video, comment, post..." | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Document ID | document_id | Meltwater identifier for the source | string | "XSo1pkTnvABoKnUY3QTueuNimTk" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Matched keywords | document_matched_keywords | Document keywords that matched the query | array(string) | "[iPhone, ... ]" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Date | document_publish_date | Date document was published | datetime | "2020-07-06T23:35:18.138Z" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| URL | document_url | URL for the document | string | "http://www.metro.us/news/the-big-stories/next-iphone" | NewsFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| External Id | document_external_id | External id for the document | string | "1299064618384601088" | X |
| Image | document_image_link | Main image for the document | string | "http://i1.myinforms.com/300x200/default.jpg" | News |
| Tags | document_tags | Tags given to the document by customer | array(string) | "[My Brand Tag]" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Hidden | document_hidden | Marked as hidden by customer in app | boolean | true,false | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Visibility | document_visibility | Document is public or private to customer | string | "public,private" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Author name | document_authors.name | Name or social handle of author | string | "Steve Jones" | NewsFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Author type | document_authors.author_information_type | Type of author | string | "social,news" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Author external id | document_authors.author_external_id | External id for the author of the document | string | "23845897" | X |
| Author profile url | document_authors.author_profile_url | Url for the authors profile | string | "https://instagram.com/meltwater" | FacebookInstagramTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Document Text — These fields provide text content for documents where available | |||||
| Title | document_title | Title of the post / article | string | "Next iPhone could unlock using a 3-D scan of your face" | NewsFacebookRedditForumsBlogsCommentsReviewsYouTube |
| Opening Text | document_opening_text | Opening text of the article, up to 140 characters | string | "No longer do you need to remember a pattern or numeric code with smartphones that unlock with just a fingerprint, but Apple Inc. is working..." | NewsFacebookInstagram |
| Hit Sentence | document_hit_sentence | The sentence which matched the query, up to 140 characters | string | "Next iPhone could unlock using a 3-D scan of your face" | NewsFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Enrichments — These fields provide NLP enrichment data for documents where available | |||||
| Sentiment | document_sentiment | Sentiment of the post / article | string | "positive,negative,neutral,unknown" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Keyphrases | document_key_phrases | Keyphrases extracted from the content | array(string) | "[fourth quarter,..]" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Language | document_language_code | Language of the content | string | "en,fr,zh-Hans,ban" | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Hashtags | document_hashtags | Hashtags extracted from the content | array(string) | FacebookInstagramRedditBlogsYouTube | |
| Named entities | document_named_entities | Entities such as organisations and people extracted from the content (includes entity type and sentiment of the mention) | array(string) | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk | |
| Location — These fields provide location details when available | |||||
| Country | source_country_code | Country of the author / source | string | "us,gb,fr,..." | NewsXForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| State | document_region | State of author / source | string | "Nevada" | NewsX |
| Sub-region | source_subregion | Sub-region of author / source | string | "Maryland" | News |
| City | document_city | City of author / source | string | "London" | NewsX |
| Geolocation | document_location_approximate.* | Geo-location of author / source | object | NewsX | |
| Reach & Engagement — These fields provide details relating to reach of a document and engagement by audiences | |||||
| Reach | source_reach | Total monthly visitors to the source, or social followers | integer | 100000 | NewsXFacebookInstagramRedditTwitchPinterestWeibo |
| Desktop Reach | source_reach_desktop | Monthly unique desktop visitors to the source | integer | 20000 | News |
| Mobile Reach | source_reach_mobile | Monthly unique mobile visitors to the source | integer | 10000 | News |
| X Social Echo | document_social_echo_twitter | The social echo of the article on Twitter | integer | 1000 | News |
| Facebook Social Echo | document_social_echo_facebook | The social echo of the article on Facebook | integer | 1000 | News |
| Reddit Social Echo | document_social_echo_reddit | The social echo of the article on Reddit | integer | 1000 | News |
| AVE | source_ave | AVE value assigned to source | integer | 1000 | NewsXFacebookInstagramTwitchPinterestWeibo |
| Engagement | document_engagement | Indicates the level of engagement for this document | integer | 45 | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalk |
| Views | document_views | Indicates the level of views for this document | integer | 4245 | NewsXTwitchPinterest |
| Views | document_estimated_views | Indicates the level of estimated views for this document | integer | 345634 | NewsTwitchPinterest |