The N | B | D API response includes up to 100 search-results and a Meta Info area with reference to API consumption and the request itself, such as the "next" URL to get the next batch of search-results matching your query.
Each result is constructed of 3 objects:
- The Thread Object provides information about the complete thread (e.g. full article text and associated comments).
- The Post Object includes information about a particular post in a thread. A post could be the article, i.e the first post, or a comment to the article.
- The External Images Object includes information about the images found on a page, including visual image analysis and metadata extracted about each image found.
Thread Object
Field Name | Description | Searchable? | Type |
---|---|---|---|
uuid | A unique ID representing the thread | Yes | String |
url | The link to the top of the thread | Yes | String |
site_full | The complete domain of the site | Yes | String |
site | The top level domain of the site | Yes | String |
site_section | A link to the section in the site where the thread was created | Yes | String |
section_title | The title of the section in the site where the thread was created | Yes | String |
title | The title of the thread | Yes | String |
title_full | The full title of the thread including prefix or suffix automatically added by the site (like the site name) | Yes | String |
published | The date/time when the thread was published | Yes | Date Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
replies_count | The number of replies to the main post | Yes | Integer |
participants_count | The number of different people who participated in the discussion | Yes | Integer |
site_type | Is the site a news | blogs | discussions source? | Yes | String |
main_image | A link to the main image presented with the article | Yes | String |
country | The article's country of origin is determined by its domain, subdomain, or site section. This is established through the country indicators in the web address (e.g. *.co.fr) or by analyzing the country that generates the most traffic. To get a full country code list, visit our CountryCode.org | Yes | String |
site_categories | A list of categories for this website or top news per country. see full list of values. | Yes | String |
social | Facebook Shares | Yes | String |
performance_score | A virality score for news and blogs posts only. The score ranges between 0-10. A score of 0 means that the post didn't do well - it was rarely or never shared. A score of 10 means that the post was "on fire" being shared thousands of times on Facebook. | Yes | Integer |
domain_rank | A rank that specifies how popular a domain is | Yes | Integer |
domain_rank_update | The date/time when the domain rank were last updated | No | Date Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
Post Object
Field Name | Description | Searchable? | Type |
---|---|---|---|
uuid | A unique ID representing a post in a thread | No | String |
url | A link to the post in the thread (goes through omgili.com on the free plan) | Yes | String |
ord_in_thread | The order in the thread, i.e if its the first post, the second etc.. | Yes | Integer |
parent_url | For threaded comments, this field provides the parent comment URL of the current post. | No | String |
author | The name of the post author | Yes | String |
published | The date/time when the post was published. | Yes | Date Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
title | The title of the post | Yes | String |
text | The text body of the post | Yes | String |
language | The language of the post | Yes | String |
external_links | A list of URLs that are linked from the post | Yes | String |
rating | For review posts, the rating parameter provides the star rating for the review. rating is a floating number between 0.0 to 5.0. Only relevant for Review API | Yes | Float |
entities/sentiment | _ persons - a list of identified people names found in the post (currently available for news/blogs posts in English) _ locations - a list of identified locations found in the post (currently available for news/blogs posts in English) _ organizations - a list of identified companies/organizations found in the post (currently available for news/blogs posts in English) ============ Sentiment _ Sentiment context attached to either a person or organization. Possible values are: positive, negative, none. | Yes | String |
crawled | The date/time when the post was crawled. | Yes | Date Format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
sentiment | The sentiment of the news article. May be either Positive, Negative or Neutral | Yes | |
categories | A list of predetermined categories matching the theme of the news article. | Yes | |
topics | A list of predetermined topics matching the theme of the news article based on the following list. | Yes | |
webz_reporter | Indicates if the article is generated using Webz Reporter feature | Yes | Boolean |
ai_allow | Indicates if the article is allowed (true) for LLM training | Yes | Boolean |
has_canonical | Indicates that the post contains a canonical HTML tag pointing to another website. This typically means the article is syndicated from that other website. | Yes | Boolean |
External Images Object
Field Name | Description | Searchable? | Type |
---|---|---|---|
url | The link to the actual image | No | String |
meta_info | Link to more information about the image | No | String |
uuid | A unique ID for the image by content. | Yes | String |
label | A list of labels that describe the visual content of the image. | Yes | Array[String] |
Meta Info
Field Name | Description | Type |
---|---|---|
totalResults | The total number of posts matching your query | Integer |
moreResultsAvailable | How many more results are available | Integer |
next | A URL to get the next batch of posts matching your query. See Pagination and Sorting] | String |
requestsLeft | How many more requests are available in your current subscription plan. | Integer |
Syndication
Field Name | Description | Searchable | Type |
---|---|---|---|
syndicated | Indicates if the article is syndicated, meaning part of similar group of articles. | Yes | Boolean |
syndicate_id | A unique ID for the syndication (group id). | Yes | String |
{
"thread": {
"uuid": "0cf6601bb0c848c87cf730df69b90ee1ae1fa629",
"url": "https://www.cbc.ca/player/play/video/9.6605650",
"site_full": "www.cbc.ca",
"site": "cbc.ca",
"site_section": "https://www.cbc.ca/player/news",
"site_categories": [
"media",
"top_news_ca",
"top_news"
],
"section_title": "News - Video | CBC.ca",
"title": "Trudeau to resign as prime minister after Liberal leadership race | CBC.ca",
"title_full": "Trudeau to resign as prime minister after Liberal leadership race | CBC.ca",
"published": "2025-01-06T19:41:00.000+02:00",
"replies_count": 0,
"participants_count": 0,
"site_type": "news",
"country": "CA",
"main_image": "https://i.cbc.ca/ais/11a8d942-d533-440e-855c-0653a4c822dc,1736184917880/full/max/0/default.jpg?im=Crop%2Crect%3D%280%2C0%2C940%2C528%29%3BResize%3D%281180%29",
"performance_score": 0,
"domain_rank": 342,
"domain_rank_updated": "2024-12-30T23:00:00.000+02:00",
"social": {
"facebook": {
"likes": 0,
"comments": 0,
"shares": 0
},
"vk": {
"shares": 0
}
}
},
"uuid": "0cf6601bb0c848c87cf730df69b90ee1ae1fa629",
"url": "https://www.cbc.ca/player/play/video/9.6605650",
"ord_in_thread": 0,
"parent_url": null,
"author": null,
"published": "2025-01-06T19:41:00.000+02:00",
"title": "Trudeau to resign as prime minister after Liberal leadership race | CBC.ca",
"text": "Prime Minister Justin Trudeau says he plans to step down once the Liberal Party has chosen a successor, bringing his time leading the country to a tumultuous end. Trudeau, who became Liberal leader in 2013 and prime minister in the fall of 2015, announced his long-awaited decision outside his official residence, Rideau Cottage, on Monday morning.",
"highlightText": "",
"highlightTitle": "",
"highlightThreadTitle": "",
"language": "english",
"sentiment": "neutral",
"categories": [
"Politics",
"Social Issue",
"Human Interest"
],
"topics": [
"Politics->political parties and movements",
"Politics->political candidates",
"Politics->national government",
"Social Issue->social condition",
"Human Interest->ceremony"
],
"ai_allow": true,
"has_canonical": false,
"webz_reporter": false,
"external_links": [],
"external_images": [],
"entities": {
"persons": [
{
"name": "Justin Trudeau",
"sentiment": "negative"
}
],
"organizations": [
{
"name": "Liberal Party",
"sentiment": "negative"
}
],
"locations": []
},
"syndication": {
"syndicated": false,
"syndicate_id": null,
"first_syndicated": false
},
"rating": null,
"crawled": "2025-01-06T20:09:41.758+02:00",
"updated": "2025-01-06T20:09:41.758+02:00"
}