Coverages
Show me this endpoint for

About

This endpoint is used for finding story coverages based on the parameters provided. The maximum number of related stories returned is 100.

Parameters

Name Type Description Notes
id [Number] This parameter is used for finding stories by story id. [optional]
notId [Number] This parameter is used for excluding stories by story id. [optional]
title String This parameter is used for finding stories whose title contains a specfic keyword. It supports boolean operators. [optional]
body String This parameter is used for finding stories whose body contains a specfic keyword. It supports boolean operators. [optional]
text String This parameter is used for finding stories whose title or body contains a specfic keyword. It supports boolean operators. [optional]
language [String] This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional] [enum: en, de, fr, it, es, pt]
notLanguage [String] This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional] [enum: en, de, fr, it, es, pt]
publishedAtStart String This parameter is used for finding stories whose published at time is greater than the specified value. Here you can find more information about how to work with dates. [optional]
publishedAtEnd String This parameter is used for finding stories whose published at time is less than the specified value. Here you can find more information about how to work with dates. [optional]
categoriesTaxonomy String This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories here. [optional] [enum: iab-qag, iptc-subjectcode]
categoriesConfident Boolean This parameter is used for finding stories whose categories are confident. You can read more about working with categories here. [optional] [default to true]
categoriesId [String] This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId [String] This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel [Number] This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel [Number] This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText [String] This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities here. [optional]
notEntitiesTitleText [String] This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities here. [optional]
entitiesTitleType [String] This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities here. [optional]
notEntitiesTitleType [String] This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities here. [optional]
entitiesTitleLinksDbpedia [String] This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities here. [optional]
notEntitiesTitleLinksDbpedia [String] This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities here. [optional]
entitiesBodyText [String] This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities here. [optional]
notEntitiesBodyText [String] This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities here. [optional]
entitiesBodyType [String] This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities here. [optional]
notEntitiesBodyType [String] This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities here. [optional]
entitiesBodyLinksDbpedia [String] This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities here. [optional]
notEntitiesBodyLinksDbpedia [String] This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities here. [optional]
sentimentTitlePolarity String This parameter is used for finding stories whose title sentiment is the specified value. [optional] [enum: positive, neutral, negative]
notSentimentTitlePolarity String This parameter is used for excluding stories whose title sentiment is the specified value. [optional] [enum: positive, neutral, negative]
sentimentBodyPolarity String This parameter is used for finding stories whose body sentiment is the specified value. [optional] [enum: positive, neutral, negative]
notSentimentBodyPolarity String This parameter is used for excluding stories whose body sentiment is the specified value. [optional] [enum: positive, neutral, negative]
mediaImagesCountMin Number This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax Number This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin Number This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax Number This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin Number This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax Number This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin Number This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax Number This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat [String] This parameter is used for finding stories whose images format are the specified value. [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
notMediaImagesFormat [String] This parameter is used for excluding stories whose images format are the specified value. [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
mediaVideosCountMin Number This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax Number This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId [Number] This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId [Number] This parameter is used for excluding stories whose author id is the specified value. [optional]
authorName String This parameter is used for finding stories whose author full name contains the specified value. [optional]
notAuthorName String This parameter is used for excluding stories whose author full name contains the specified value. [optional]
sourceId [Number] This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId [Number] This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName [String] This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName [String] This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain [String] This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain [String] This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry [String] This parameter is used for finding stories whose source country is the specified value. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]
notSourceLocationsCountry [String] This parameter is used for excluding stories whose source country is the specified value. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]
sourceLocationsState [String] This parameter is used for finding stories whose source state/province is the specified value. Here you can find more information about how to work with locations. [optional]
notSourceLocationsState [String] This parameter is used for excluding stories whose source state/province is the specified value. Here you can find more information about how to work with locations. [optional]
sourceLocationsCity [String] This parameter is used for finding stories whose source city is the specified value. Here you can find more information about how to work with locations. [optional]
notSourceLocationsCity [String] This parameter is used for excluding stories whose source city is the specified value. Here you can find more information about how to work with locations. [optional]
sourceScopesCountry [String] This parameter is used for finding stories whose source scopes is the specified country value. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]
notSourceScopesCountry [String] This parameter is used for excluding stories whose source scopes is the specified country value. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]
sourceScopesState [String] This parameter is used for finding stories whose source scopes is the specified state/province value. Here you can find more information about how to work with locations. [optional]
notSourceScopesState [String] This parameter is used for excluding stories whose source scopes is the specified state/province value. Here you can find more information about how to work with locations. [optional]
sourceScopesCity [String] This parameter is used for finding stories whose source scopes is the specified city value. Here you can find more information about how to work with locations. [optional]
notSourceScopesCity [String] This parameter is used for excluding stories whose source scopes is the specified city value. Here you can find more information about how to work with locations. [optional]
sourceScopesLevel [String] This parameter is used for finding stories whose source scopes is the specified level value. Here you can find more information about how to work with locations. [optional] [enum: international, national, local]
notSourceScopesLevel [String] This parameter is used for excluding stories whose source scopes is the specified level value. Here you can find more information about how to work with locations. [optional] [enum: international, national, local]
sourceLinksInCountMin Number This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here. [optional]
sourceLinksInCountMax Number This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here. [optional]
sourceRankingsAlexaRankMin Number This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here. [optional]
sourceRankingsAlexaRankMax Number This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here. [optional]
sourceRankingsAlexaCountry [String] This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports ISO 3166-1 alpha-2 country codes. You can read more about working with Alexa ranks here. [optional]
socialSharesCountFacebookMin Number This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax Number This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin Number This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax Number This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin Number This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax Number This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin Number This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax Number This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
cluster Boolean This parameter enables clustering for the returned stories. You can read more about working with clustering here. [optional] [default to false]
clusterAlgorithm String This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and k-means algorithms. You can read more about working with clustering here. [optional] [default to lingo] [enum: stc, lingo, kmeans]
_return [String] This parameter is used for specifying return fields. [optional] [enum: id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links]
storyId Number A story id [optional]
storyUrl String An article or webpage [optional]
storyTitle String Title of the article [optional]
storyBody String Body of the article [optional]
storyPublishedAt Date Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the XML Schema specification (ISO 8601). [optional]
storyLanguage String This parameter is used for setting the language of the story. It supports ISO 639-1 language codes. [optional] [default to auto] [enum: auto, en, de, fr, it, es, pt]
perPage Number This parameter is used for specifying number of items in each page. [optional] [default to 3]

Return type

Coverages

Example

var AylienNewsApi = require('aylien-news-api');

var apiInstance = new AylienNewsApi.DefaultApi();

// Configure API key authorization: app_id
var app_id = apiInstance.apiClient.authentications['app_id'];
app_id.apiKey = "YOUR_APP_ID";

// Configure API key authorization: app_key
var app_key = apiInstance.apiClient.authentications['app_key'];
app_key.apiKey = "YOUR_APP_KEY";

var opts = { 
  'id': [56],
  'notId': [154211],
  'title': "startup AND (raise OR raised OR raising OR raises)",
  'body': "startup",
  'text': "startup company",
  'language': ["en", "de"],
  'notLanguage': ["es", "it"],
  'publishedAtStart': "NOW-10DAYS",
  'publishedAtEnd': "NOW",
  'categoriesTaxonomy': "iptc-subjectcode",
  'categoriesConfident': true,
  'categoriesId': ["11000000"],
  'notCategoriesId': ["04002001"],
  'categoriesLevel': [1],
  'notCategoriesLevel': [3],
  'entitiesTitleText': ["GNU/Linux"],
  'notEntitiesTitleText': ["Microsoft", "Google"],
  'entitiesTitleType': ["Software", "Organization"],
  'notEntitiesTitleType': ["Person", "Agent"],
  'entitiesTitleLinksDbpedia': ["http://dbpedia.org/resource/Linux"],
  'notEntitiesTitleLinksDbpedia': ["http://dbpedia.org/resource/Windows"],
  'entitiesBodyText': ["Free Software"],
  'notEntitiesBodyText': ["Open Source"],
  'entitiesBodyType': ["Software", "Organization"],
  'notEntitiesBodyType': ["Person", "Agent"],
  'entitiesBodyLinksDbpedia': ["http://dbpedia.org/resource/Linux"],
  'notEntitiesBodyLinksDbpedia': ["http://dbpedia.org/resource/Microsoft"],
  'sentimentTitlePolarity': "positive",
  'notSentimentTitlePolarity': "neutral",
  'sentimentBodyPolarity': "negative",
  'notSentimentBodyPolarity': "neutral",
  'mediaImagesCountMin': 1,
  'mediaImagesCountMax': 2,
  'mediaImagesWidthMin': 640,
  'mediaImagesWidthMax': 1024,
  'mediaImagesHeightMin': 480,
  'mediaImagesHeightMax': 800,
  'mediaImagesContentLengthMin': 25412,
  'mediaImagesContentLengthMax': 369521,
  'mediaImagesFormat': ['JPEG', 'BMP', 'GIF'],
  'notMediaImagesFormat': ['TIFF', 'PNG'],
  'mediaVideosCountMin': 2,
  'mediaVideosCountMax': 2,
  'authorId': [5411],
  'notAuthorId': [65211],
  'authorName': "John Doe",
  'notAuthorName': "Mike Wali",
  'sourceId': [1422],
  'notSourceId': [51],
  'sourceName': ["BBC"],
  'notSourceName': ["Fox News"],
  'sourceDomain': ["bbc.co.uk"],
  'notSourceDomain': ["foxnews.com"],
  'sourceLocationsCountry': ["US"],
  'notSourceLocationsCountry': ["IE"],
  'sourceLocationsState': ["California"],
  'notSourceLocationsState': ["Arizona"],
  'sourceLocationsCity': ["Los Angeles"],
  'notSourceLocationsCity': ["Chandler"],
  'sourceScopesCountry': ["IE"],
  'notSourceScopesCountry': ["IT"],
  'sourceScopesState': ["Co Dublin"],
  'notSourceScopesState': ["Co Wicklow"],
  'sourceScopesCity': ["Dublin City"],
  'notSourceScopesCity': ["Cork"],
  'sourceScopesLevel': ["local"],
  'notSourceScopesLevel': ["national"],
  'sourceLinksInCountMin': 254111,
  'sourceLinksInCountMax': 352541,
  'sourceRankingsAlexaRankMin': 36,
  'sourceRankingsAlexaRankMax': 500,
  'sourceRankingsAlexaCountry': ["IE"],
  'socialSharesCountFacebookMin': 3521,
  'socialSharesCountFacebookMax': 5841,
  'socialSharesCountGooglePlusMin': 2514,
  'socialSharesCountGooglePlusMax': 36521,
  'socialSharesCountLinkedinMin': 6521,
  'socialSharesCountLinkedinMax': 36521,
  'socialSharesCountRedditMin': 14125,
  'socialSharesCountRedditMax': 95412,
  'cluster': false,
  'clusterAlgorithm': "lingo",
  '_return': ["id", "title", "body", "published_at"],
  'storyId': 789,
  'storyUrl': "https://techcrunch.com/2016/04/07/aylien-launches-news-analysis-api-powered-by-its-deep-learning-tech/",
  'storyTitle': "Aylien launches news analysis API powered by its deep learning tech",
  'storyBody': "Text analysis startup Aylien, which uses deep learning ...",
  'storyPublishedAt': new Date("2013-10-20T19:20:30Z"),
  'storyLanguage': "auto",
  'perPage': 3
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
  }
};
apiInstance.listCoverages(opts, callback);