API JSON (api.json)
The recommended general-purpose template for most API integrations. Includes all data fields most customers need.
At a glance
| Template code | api.json |
| Output formats | JSON |
| Supported endpoints | Listening API exports, Listening API streaming, Explore+ API search |
| Streaming support | Yes |
See Conventions for behaviour shared across all templates.
Field reference
| Field | Path | Description | Type | Example | Earned Sources | Owned Sources |
|---|---|---|---|---|---|---|
| Document Metadata — High-level details for documents, such as the document type and ID | ||||||
| Document ID | id | Unique ID of the document in the Meltwater platform | string | "1713459776000_K49ugt285FchyyIqJ15D85lyR5wA" | All | XFacebookInstagramTikTokLinkedIn |
| Published Date & Time | published_date | Date & time when the document was published by the source | datetime | "2024-01-01T14:30:45.000Z" | All | XFacebookInstagramTikTokLinkedIn |
| Indexed Date & Time | indexed_date | Date & time when the document was added to the Meltwater platform | datetime | "2024-01-01T14:30:45.000Z" | All | XFacebookInstagramTikTokLinkedIn |
| URL | url | URL of the document | string | "https://edition.cnn.com/2024/04/21/world/lyrid-meteor-shower-april-pink-moon-scn" | NewsRSSFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | FacebookInstagramTikTokLinkedIn |
| Parent URL | parent.url | The URL of the parent document, for example if this document is a reply | string | "https://lihkg.com/thread/3680511/page/29" | FacebookRedditForumsCommentsYouTube | — |
| Thread Title | thread.title | Title of the thread this document relates to | string | "What do you think of the latest iPhone?" | FacebookForumsKakaoTalk | — |
| Thread URL | thread.url | URL of the thread this document relates to | string | "https://lihkg.com/thread/3680511/page/29" | FacebookRedditForums | |
| Document External ID | external_id | Unique ID of the document in the source platform | string | "1781005504061268063" | X | X |
| Source Metadata — Details of the source that the document originates from | ||||||
| Information Type | source.information_type | Information type of the source, for example 'news' | string | "news""social" | All | XFacebookInstagramTikTokLinkedIn |
| Source ID | source.id | Unique ID of the source in the Meltwater platform | string | "social:tiktok" | NewsRSSXFacebookInstagramRedditForumsBlogsCommentsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | XFacebookInstagramTikTokLinkedIn |
| Source Type | source.type | The type of the source, for example a forum | string | "online news""rss""blog""forum""reviews""comments""social network" | All | XFacebookInstagramTikTokLinkedIn |
| Source Name | source.name | The name of the source | string | "New York Times""Facebook" | NewsRSSXFacebookInstagramRedditForumsBlogsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | XFacebookInstagramTikTokLinkedIn |
| Source Domain | source.domain | Domain or subdomain for the source | string | "bbc.com" | NewsRSSFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | XFacebookInstagramTikTokLinkedIn |
| Source URL | source.url | URL of the source online | string | "http://www.bbc.com" | NewsRSSFacebookInstagramRedditForumsBlogsCommentsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTok | XFacebookInstagramTikTokLinkedIn |
| Outlet Types | source.outlet_types | The type of outlet, when a news source | array(string) | "magazine""blog" | NewsBroadcast | — |
| Match Context — Details of why this document has been matched for output | ||||||
| Matched Input | matched.inputs | Inputs that caused the document to match | array(object) | {"type": "search", "name": "My Search", "id": 1234 }{"type": "tag", "name": "My Tag" } | All | XFacebookInstagramTikTokLinkedIn |
| Keywords | matched.keywords | Keywords that were found and led to the match | array(string) | "Tesla""artificial intelligence" | All | XFacebookInstagramTikTokLinkedIn |
| Hit Sentence | matched.hit_sentence | Sentence within the document that led to the match | string | "..announced today that they plan to launch a new product featuring new AI capabilities..." | NewsRSSFacebookInstagramForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | FacebookInstagramTikTokLinkedIn |
| Author — Details of the document's author, such as name or handle | ||||||
| Author Name | author.name | Name of the document's author | string | "John Smith" | NewsRSSFacebookForumsBlogsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTok | XFacebookTikTok |
| Author Handle | author.handle | Handle of the document's author | string | "john_smith" | FacebookRedditBlogsCommentsTwitchPinterestBilibiliDouyinWeiboWeChatYoukuLineVoomKakaoTalkTikTok | XInstagramTikTok |
| Author Profile URL | author.profile_url | Profile URL of the document's author | string | "https://instagram.com/john_smith" | FacebookRedditBlogsReviewsYouTubeTwitchPinterestBilibiliDouyinWeiboWeChatYoukuLineVoomKakaoTalkTikTok | XInstagram |
| Author External ID | author.external_id | ID of the author in the source platform | string | "1363119296" | X | X |
| Content — Content fields for the document, such as title | ||||||
| Title | content.title | Title of the document | string | "Today Joe Biden announced his plans for social care" | NewsRSSFacebookForumsBlogsYouTubeTwitchBilibiliDouyinREDWeChatYoukuKakaoTalkBroadcast | — |
| Opening Text | content.opening_text | Opening text of the document | string | "In the past 20 years, the reverence for the film has only grown, to the point that Napoleon (Jon Heder), Pedro (Efren Ramirez) and Uncle ..." | NewsRSSFacebookInstagramForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTok | XFacebookInstagramTikTokLinkedIn |
| Body | content.body | Text content of the document. For Facebook and Instagram, the full text is supplied. For other social sources the first 280 characters, for news the first 140 characters. | string | "In the past 20 years, the reverence for the film has only grown, to the point that Napoleon (Jon Heder), Pedro (Efren Ramirez) and Uncle ..." | FacebookInstagramForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTok | FacebookInstagramTikTok |
| By Line | content.byline | By line of the document, as provided for news articles | string | "Written by Jane Doe" | NewsRSS | — |
| Image URL | content.image | URL for the main image of a document | string | "http://images.newsite.com/path/to/image.jpg" | NewsXFacebookInstagramRedditForumsBlogsYouTubeTwitchPinterestBilibiliDouyinREDWeiboYoukuLineVoomKakaoTalkTikTok | InstagramTikTok |
| Hashtags | content.hashtags | Hashtags within the document content | array(string) | "#ai""#course" | InstagramBlogsYouTubeTwitchPinterestBilibiliDouyinREDWeiboLineVoomTikTok | FacebookInstagramTikTok |
| Mentions | content.mentions | Mentions within the document content | array(string) | "@BBC""@CNN" | InstagramYouTubeTikTok | |
| Emojis | content.emojis | Emojis within the document content | array(string) | "😂""👍""🔥" | FacebookInstagramForumsBlogsCommentsTwitchPinterestDouyinREDWeiboWeChatLineVoomKakaoTalkTikTok | FacebookInstagramTikTok |
| Links | content.links | Links found within the document content | array(string) | "http://www.newsite.com/link/to/article" | NewsFacebookInstagramRedditForumsBlogsYouTubeTwitchPinterestBilibiliWeiboWeChatYoukuLineVoom | — |
| Content Type | content_type | The type of content contained in the document | string | "news article""other""audio""video""review""comment""blog post""forum post""forum post reply""direct message""quote""repost""reply""comment""social post" | All | XFacebookInstagramTikTokLinkedIn |
| Enrichments — Enrichments applied by the Meltwater platform, such as sentiment | ||||||
| Language Code | enrichments.language_code | 2-letter code of the language detected for the document | string | "en""fr""de" | All | XFacebookInstagramTikTokLinkedIn |
| Sentiment | enrichments.sentiment | Overall sentiment of the document | string | "positive""neutral""negative""unknown" | NewsRSSXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboYoukuLineVoomKakaoTalkTikTokBroadcast | XFacebookInstagramTikTokLinkedIn |
| Keyphrases | enrichments.keyphrases | Keyphrases found within the document content | array(string) | "Machine Learning""Artificial Intelligence" | NewsRSSXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | XFacebookInstagramTikTokLinkedIn |
| Named Entities | enrichments.named_entities | Named entities detected in the content with sentiment and type | array(object) | {"name": "Emerging Technologies", "sentiment": "positive", "type": "organization"} | NewsRSSXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkTikTokBroadcast | FacebookInstagramTikTokLinkedIn |
| Location — Location details, for example the country of the document's origin | ||||||
| Country Code | location.country_code | 2-letter code of the country where the document was published | string | "us""fr" | NewsRSSXFacebookInstagramRedditForumsBlogsCommentsReviewsYouTubeTwitchPinterestBilibiliDouyinREDWeiboWeChatYoukuLineVoomKakaoTalkBroadcast | XFacebookInstagramTikTokLinkedIn |
| City | location.city | City where the document was published | string | "London""Paris" | NewsXFacebookWeibo | — |
| State | location.state | State where the document was published | string | "California""Florida" | NewsXFacebookDouyinWeibo | — |
| Region | location.region | Region where the document was published | string | "Rhode Island" | NewsXFacebookDouyinWeibo | — |
| Geo | location.geo | Approximate latitude and longitude where the document was published | object | {"latitude": 43.64801, "longitude": -93.36827} | NewsXFacebookInstagramRedditForumsBlogsCommentsReviewsTwitchBilibiliDouyinWeiboWeChatYoukuBroadcast | X |
| Source Metrics — Metrics for the source of the document, such as reach | ||||||
| AVE | source.metrics.ave | Advertising Value Equivalency of the document | numeric | 10.42 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalkBroadcast | X |
| Reach | source.metrics.reach | Reach for the document, for example number of followers for social authors, or estimate of number of visitors for a news site | numeric | 1532 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalkBroadcast | X |
| Global Reach | source.metrics.global_reach | The estimated audience for a source across the globe. | numeric | 13521 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalk | X |
| National Reach | source.metrics.national_reach | The estimated audience for a source in the source's country. | numeric | 13521 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalkBroadcast | X |
| Local Reach | source.metrics.local_reach | The estimated audience for a source for a defined local market, such as a city, region, or DMA. | numeric | 13521 | NewsRSSXFacebookRedditTwitchPinterestWeiboKakaoTalk | X |
| Desktop Reach | source.metrics.reach_desktop | Estimate of number of visitors for a news site using a desktop computer | numeric | 1002 | NewsRSS | — |
| Mobile Reach | source.metrics.reach_mobile | Estimate of number of visitors for a news site using a mobile device | numeric | 987 | NewsRSS | — |
| Document Metrics — Metrics for the document, such as engagement and social echo | ||||||
| Editorial Echo | metrics.editorial_echo | How many times the article is referenced with a hyperlink in the body of a different article | numeric | 1000 | News | — |
| Social Echo | metrics.social_echo.total | Number of times an article has been shared on social networks | numeric | 1054 | News | — |
| Social Echo - X | metrics.social_echo.x | Number of times an article has been shared on X | numeric | 10 | News | — |
| Social Echo - Facebook | metrics.social_echo.facebook | Number of times an article has been shared on Facebook | numeric | 52 | News | — |
| Social Echo - Reddit | metrics.social_echo.reddit | Number of times an article has been shared Reddit | numeric | 19 | News | — |
| Views | metrics.views | Number of views of the social post | numeric | 100342 | XTwitchBilibiliYouku | — |
| Estimated Views | metrics.estimated_views | Estimated views for a news article based on the reach of the source | numeric | 10012 | News | — |
| Engagement | metrics.engagement.total | Total engagement for the social post or article | numeric | 910 | NewsXFacebookInstagramForumsBlogsCommentsPinterestBilibiliDouyinREDWeiboLineVoomTikTok | TikTok |
| Likes | metrics.engagement.likes | Number of likes for the social post | numeric | 10 | XFacebookBlogsTikTok | TikTokLinkedIn |
| Replies | metrics.engagement.replies | Number of replies for the social post | numeric | 18 | FacebookInstagramRedditCommentsBilibiliDouyinREDWeiboLineVoomKakaoTalkTikTok | TikTokLinkedIn |
| Comments | metrics.engagement.comments | Number of comments for the social post | numeric | 10 | FacebookInstagramTikTok | TikTok |
| Shares | metrics.engagement.shares | Shares of the document | numeric | 23 | FacebookPinterestWeiboLineVoomKakaoTalkTikTok | TikTok |
| Quotes | metrics.engagement.quotes | Number of quotes of the social post | numeric | 10 | X | — |
| Reposts | metrics.engagement.reposts | Number of reposts of the social post | numeric | 10 | X | — |
| Reactions | metrics.engagement.reactions | Total number of reactions for the social post | numeric | 17 | XFacebookInstagramRedditBlogsBilibiliDouyinREDWeiboLineVoomKakaoTalkTikTok | TikTokLinkedIn |
| Customer Context — Customer-specific metadata for the document, such as if the document has been tagged | ||||||
| Tags | custom.tags | Tags applied to the document in the Meltwater application | array(string) | "My tag""Brand mentions" | All | FacebookInstagramTikTokLinkedIn |
| Hidden | custom.hidden | True if the document has been hidden in the Meltwater application | boolean | truefalse | All | XFacebookInstagramTikTokLinkedIn |
| Visibility | custom.visible | Whether the document is public (available to all customers), or private to the customer exporting data | string | "public""private" | All | XFacebookInstagramTikTokLinkedIn |
| Custom CategoriesExports only | custom.custom_categories | If Custom Categories are specified for classification, which categories match this document | array(object) | {"id":534,"name":"BMW"}{"id":73016,"name":"Toyota"} | All | XFacebookInstagramTikTokLinkedIn |
| Custom FieldsExplore+ only | custom.custom_fields | Custom Field values that have been matched to this document through assignment rules | array(object) | { "id": 123, "name": "Environment", "values": [{ "id": 456, "name": "Green Energy" }] } | All | XFacebookInstagramTikTokLinkedIn |