Skip to content
This repository has been archived by the owner on Jul 1, 2020. It is now read-only.

Latest commit

 

History

History
1820 lines (1648 loc) · 326 KB

DefaultApi.md

File metadata and controls

1820 lines (1648 loc) · 326 KB
Raw

Aylien.NewsApi.Api.DefaultApi

All URIs are relative to https://api.aylien.com/news

Method HTTP request Description
ListAutocompletes GET /autocompletes List autocompletes
ListClusters GET /clusters List Clusters
ListCoverages GET /coverages List coverages
ListHistograms GET /histograms List histograms
ListRelatedStories GET /related_stories List related stories
ListStories GET /stories List Stories
ListTimeSeries GET /time_series List time series
ListTrends GET /trends List trends

ListAutocompletes

Autocompletes ListAutocompletes (string type, string term, string language = null, int? perPage = null)

List autocompletes

The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below. For example, if you provide the autocompletes endpoint with the term New York C and select the type dbpedia_resources, the API will return links to the DBpedia resources New_York_City, New_York_City_Subway, New_York_City_Police_Department, and so on.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListAutocompletesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var type = source_names;  // string | This parameter is used for defining the type of autocompletes. 
            var term = News;  // string | This parameter is used for finding autocomplete objects that contain the specified value. 
            var language = language_example;  // string | This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional)  (default to en)
            var perPage = 56;  // int? | This parameter is used for specifying number of items in each page.  (optional)  (default to 3)

            try
            {
                // List autocompletes
                Autocompletes result = apiInstance.ListAutocompletes(type, term, language, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListAutocompletes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
type string This parameter is used for defining the type of autocompletes.
term string This parameter is used for finding autocomplete objects that contain the specified value.
language string This parameter is used for autocompletes whose language is the specified value. It supports ISO 639-1 language codes. [optional] [default to en]
perPage int? This parameter is used for specifying number of items in each page. [optional] [default to 3]

Return type

Autocompletes

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of autocompletes * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListClusters

Clusters ListClusters (List id = null, List notId = null, int? storyCountMin = null, int? storyCountMax = null, string timeStart = null, string timeEnd = null, string earliestStoryStart = null, string earliestStoryEnd = null, string latestStoryStart = null, string latestStoryEnd = null, List locationCountry = null, List notLocationCountry = null)

List Clusters

The clusters endpoint is used to return clusters based on parameters you set in your query.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListClustersExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding clusters by cluster id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding clusters by cluster id.  (optional) 
            var storyCountMin = 56;  // int? | This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them.  (optional) 
            var storyCountMax = 56;  // int? | This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them.  (optional) 
            var timeStart = timeStart_example;  // string | This parameter is used for finding clusters whose creation time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var timeEnd = timeEnd_example;  // string | This parameter is used for finding clusters whose creation time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var earliestStoryStart = earliestStoryStart_example;  // string | This parameter is used for finding clusters whose publication date of its earliest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var earliestStoryEnd = earliestStoryEnd_example;  // string | This parameter is used for finding clusters whose publication date of its earliest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var latestStoryStart = latestStoryStart_example;  // string | This parameter is used for finding clusters whose publication date of its latest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var latestStoryEnd = latestStoryEnd_example;  // string | This parameter is used for finding clusters whose publication date of its latest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var locationCountry = new List<string>(); // List<string> | This parameter is used for finding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notLocationCountry = new List<string>(); // List<string> | This parameter is used for excluding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 

            try
            {
                // List Clusters
                Clusters result = apiInstance.ListClusters(id, notId, storyCountMin, storyCountMax, timeStart, timeEnd, earliestStoryStart, earliestStoryEnd, latestStoryStart, latestStoryEnd, locationCountry, notLocationCountry);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListClusters: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding clusters by cluster id. [optional]
notId List<long> This parameter is used for excluding clusters by cluster id. [optional]
storyCountMin int? This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them. [optional]
storyCountMax int? This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them. [optional]
timeStart string This parameter is used for finding clusters whose creation time is greater than the specified value. Here you can find more information about how to work with dates. [optional]
timeEnd string This parameter is used for finding clusters whose creation time is less than the specified value. Here you can find more information about how to work with dates. [optional]
earliestStoryStart string This parameter is used for finding clusters whose publication date of its earliest story is greater than the specified value. Here you can find more information about how to work with dates. [optional]
earliestStoryEnd string This parameter is used for finding clusters whose publication date of its earliest story is less than the specified value. Here you can find more information about how to work with dates. [optional]
latestStoryStart string This parameter is used for finding clusters whose publication date of its latest story is greater than the specified value. Here you can find more information about how to work with dates. [optional]
latestStoryEnd string This parameter is used for finding clusters whose publication date of its latest story is less than the specified value. Here you can find more information about how to work with dates. [optional]
locationCountry List<string> This parameter is used for finding clusters belonging to a specific country. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]
notLocationCountry List<string> This parameter is used for excluding clusters belonging to a specific country. It supports ISO 3166-1 alpha-2 country codes. Here you can find more information about how to work with locations. [optional]

Return type

Clusters

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of clusters * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCoverages

Coverages ListCoverages (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List linksPermalink = null, List notLinksPermalink = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, List clusters = null, List _return = null, long? storyId = null, string storyUrl = null, string storyTitle = null, string storyBody = null, DateTime? storyPublishedAt = null, string storyLanguage = null, int? perPage = null)

List coverages

The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListCoveragesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var linksPermalink = new List<string>(); // List<string> | This parameter is used to find stories based on their url.  (optional) 
            var notLinksPermalink = new List<string>(); // List<string> | This parameter is used to exclude stories based on their url.  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 
            var clusters = new List<string>(); // List<string> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).  (optional) 
            var _return = _return_example;  // List<string> | This parameter is used for specifying return fields. (optional) 
            var storyId = 789;  // long? | A story id (optional) 
            var storyUrl = storyUrl_example;  // string | An article or webpage (optional) 
            var storyTitle = storyTitle_example;  // string | Title of the article (optional) 
            var storyBody = storyBody_example;  // string | Body of the article (optional) 
            var storyPublishedAt = 2013-10-20T19:20:30+01:00;  // DateTime? | 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)](https://www.w3.org/TR/xmlschema-2/#dateTime).  (optional) 
            var storyLanguage = storyLanguage_example;  // string | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional)  (default to auto)
            var perPage = 56;  // int? | This parameter is used for specifying number of items in each page.  (optional)  (default to 3)

            try
            {
                // List coverages
                Coverages result = apiInstance.ListCoverages(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, linksPermalink, notLinksPermalink, language, notLanguage, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, clusters, _return, storyId, storyUrl, storyTitle, storyBody, storyPublishedAt, storyLanguage, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListCoverages: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
linksPermalink List<string> This parameter is used to find stories based on their url. [optional]
notLinksPermalink List<string> This parameter is used to exclude stories based on their url. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
clusters List<string> This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering here. [optional]
_return List<string> This parameter is used for specifying return fields. [optional]
storyId long? 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 DateTime? 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]
perPage int? This parameter is used for specifying number of items in each page. [optional] [default to 3]

Return type

Coverages

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of coverages * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListHistograms

Histograms ListHistograms (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List linksPermalink = null, List notLinksPermalink = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, int? intervalStart = null, int? intervalEnd = null, int? intervalWidth = null, string field = null)

List histograms

For the numerical metadata that the News API gathers (such as word counts or social shares for example), you can use the histograms endpoint to access and display this information. As this endpoint does not return actual stories, the results you are given will not count towards your story allowance provided by your subscription, so you can effectively query this endpoint free of charge.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListHistogramsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var linksPermalink = new List<string>(); // List<string> | This parameter is used to find stories based on their url.  (optional) 
            var notLinksPermalink = new List<string>(); // List<string> | This parameter is used to exclude stories based on their url.  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 
            var intervalStart = 56;  // int? | This parameter is used for setting the start data point of histogram intervals.  (optional) 
            var intervalEnd = 56;  // int? | This parameter is used for setting the end data point of histogram intervals.  (optional) 
            var intervalWidth = 56;  // int? | This parameter is used for setting the width of histogram intervals.  (optional) 
            var field = field_example;  // string | This parameter is used for specifying the y-axis variable for the histogram.  (optional)  (default to social_shares_count)

            try
            {
                // List histograms
                Histograms result = apiInstance.ListHistograms(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, linksPermalink, notLinksPermalink, language, notLanguage, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, intervalStart, intervalEnd, intervalWidth, field);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListHistograms: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
linksPermalink List<string> This parameter is used to find stories based on their url. [optional]
notLinksPermalink List<string> This parameter is used to exclude stories based on their url. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
intervalStart int? This parameter is used for setting the start data point of histogram intervals. [optional]
intervalEnd int? This parameter is used for setting the end data point of histogram intervals. [optional]
intervalWidth int? This parameter is used for setting the width of histogram intervals. [optional]
field string This parameter is used for specifying the y-axis variable for the histogram. [optional] [default to social_shares_count]

Return type

Histograms

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of the histogram intervals * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRelatedStories

RelatedStories ListRelatedStories (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List linksPermalink = null, List notLinksPermalink = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, List clusters = null, List _return = null, long? storyId = null, string storyUrl = null, string storyTitle = null, string storyBody = null, string boostBy = null, string storyLanguage = null, int? perPage = null)

List related stories

This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListRelatedStoriesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var linksPermalink = new List<string>(); // List<string> | This parameter is used to find stories based on their url.  (optional) 
            var notLinksPermalink = new List<string>(); // List<string> | This parameter is used to exclude stories based on their url.  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 
            var clusters = new List<string>(); // List<string> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).  (optional) 
            var _return = _return_example;  // List<string> | This parameter is used for specifying return fields. (optional) 
            var storyId = 789;  // long? | A story id (optional) 
            var storyUrl = storyUrl_example;  // string | An article or webpage (optional) 
            var storyTitle = storyTitle_example;  // string | Title of the article (optional) 
            var storyBody = storyBody_example;  // string | Body of the article (optional) 
            var boostBy = boostBy_example;  // string | This parameter is used for boosting the result by the specified value.  (optional) 
            var storyLanguage = storyLanguage_example;  // string | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional)  (default to auto)
            var perPage = 56;  // int? | This parameter is used for specifying number of items in each page.  (optional)  (default to 3)

            try
            {
                // List related stories
                RelatedStories result = apiInstance.ListRelatedStories(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, linksPermalink, notLinksPermalink, language, notLanguage, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, clusters, _return, storyId, storyUrl, storyTitle, storyBody, boostBy, storyLanguage, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListRelatedStories: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
linksPermalink List<string> This parameter is used to find stories based on their url. [optional]
notLinksPermalink List<string> This parameter is used to exclude stories based on their url. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
clusters List<string> This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering here. [optional]
_return List<string> This parameter is used for specifying return fields. [optional]
storyId long? 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]
boostBy string This parameter is used for boosting the result by the specified value. [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]
perPage int? This parameter is used for specifying number of items in each page. [optional] [default to 3]

Return type

RelatedStories

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of related stories * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListStories

Stories ListStories (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List language = null, List notLanguage = null, List linksPermalink = null, List notLinksPermalink = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, List clusters = null, List _return = null, string sortBy = null, string sortDirection = null, string cursor = null, int? perPage = null)

List Stories

The stories endpoint is used to return stories based on parameters you set in your query. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, which you can use to narrow down your query.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListStoriesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var linksPermalink = new List<string>(); // List<string> | This parameter is used to find stories based on their url.  (optional) 
            var notLinksPermalink = new List<string>(); // List<string> | This parameter is used to exclude stories based on their url.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 
            var clusters = new List<string>(); // List<string> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).  (optional) 
            var _return = _return_example;  // List<string> | This parameter is used for specifying return fields. (optional) 
            var sortBy = sortBy_example;  // string | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).  (optional)  (default to published_at)
            var sortDirection = sortDirection_example;  // string | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).  (optional)  (default to desc)
            var cursor = cursor_example;  // string | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).  (optional)  (default to "*")
            var perPage = 56;  // int? | This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)  (optional)  (default to 10)

            try
            {
                // List Stories
                Stories result = apiInstance.ListStories(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, language, notLanguage, linksPermalink, notLinksPermalink, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, clusters, _return, sortBy, sortDirection, cursor, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListStories: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
linksPermalink List<string> This parameter is used to find stories based on their url. [optional]
notLinksPermalink List<string> This parameter is used to exclude stories based on their url. [optional]
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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
clusters List<string> This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering here. [optional]
_return List<string> This parameter is used for specifying return fields. [optional]
sortBy string This parameter is used for changing the order column of the results. You can read about sorting results here. [optional] [default to published_at]
sortDirection string This parameter is used for changing the order direction of the result. You can read about sorting results here. [optional] [default to desc]
cursor string This parameter is used for finding a specific page. You can read more about pagination of results here. [optional] [default to "*"]
perPage int? This parameter is used for specifying number of items in each page You can read more about pagination of results here [optional] [default to 10]

Return type

Stories

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of stories * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListTimeSeries

TimeSeriesList ListTimeSeries (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List language = null, List notLanguage = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, string publishedAtStart = null, string publishedAtEnd = null, string period = null)

List time series

The time series endpoint allows you to track information contained in stories over time. This information can be anything from mentions of a topic or entities, sentiment about a topic, or the volume of stories published by a source, to name but a few. The full list of parameters is given below. Using the Date Math Syntax, you can easily set your query to return information from any time period, from the current point in time to when the News API started collecting stories. The returned information can be rounded to a time also specified by you, for example by setting the results into hourly, daily, or weekly data points.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListTimeSeriesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional)  (default to "NOW-7DAYS/DAY")
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional)  (default to "NOW/DAY")
            var period = period_example;  // string | The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).  (optional)  (default to "+1DAY")

            try
            {
                // List time series
                TimeSeriesList result = apiInstance.ListTimeSeries(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, language, notLanguage, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, publishedAtStart, publishedAtEnd, period);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListTimeSeries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]
publishedAtStart 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] [default to "NOW-7DAYS/DAY"]
publishedAtEnd 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] [default to "NOW/DAY"]
period string The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are Supported keywords. [optional] [default to "+1DAY"]

Return type

TimeSeriesList

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of time series * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListTrends

Trends ListTrends (string field, List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List linksPermalink = null, List notLinksPermalink = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null)

List trends

The trends endpoint allows you to identify the most-mentioned entities, concepts and keywords relevant to your query. For example, this endpoint allows you to set parameters like a time period, a subject category, or an entity, and your request will return the most mentioned entities or keywords that are mentioned in relation to your query.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
using Aylien.NewsApi.Model;

namespace Example
{
    public class ListTrendsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.aylien.com/news";
            // Configure API key authorization: app_id
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
            // Configure API key authorization: app_key
            Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");

            var apiInstance = new DefaultApi(Configuration.Default);
            var field = keywords;  // string | This parameter is used to specify the trend field. 
            var id = new List<long>(); // List<long> | This parameter is used for finding stories by story id.  (optional) 
            var notId = new List<long>(); // List<long> | This parameter is used for excluding stories by story id.  (optional) 
            var title = title_example;  // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var body = body_example;  // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var text = text_example;  // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnTitle = translationsEnTitle_example;  // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnBody = translationsEnBody_example;  // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var translationsEnText = translationsEnText_example;  // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).  (optional) 
            var linksPermalink = new List<string>(); // List<string> | This parameter is used to find stories based on their url.  (optional) 
            var notLinksPermalink = new List<string>(); // List<string> | This parameter is used to exclude stories based on their url.  (optional) 
            var language = language_example;  // List<string> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var notLanguage = language_example;  // List<string> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.  (optional) 
            var publishedAtStart = publishedAtStart_example;  // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var publishedAtEnd = publishedAtEnd_example;  // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).  (optional) 
            var categoriesTaxonomy = categoriesTaxonomy_example;  // 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](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesConfident = true;  // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional)  (default to true)
            var categoriesId = new List<string>(); // List<string> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesId = new List<string>(); // List<string> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var categoriesLevel = new List<int>(); // List<int> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var notCategoriesLevel = new List<int>(); // List<int> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).  (optional) 
            var entitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesTitleLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyText = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyType = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var entitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var notEntitiesBodyLinksDbpedia = new List<string>(); // List<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](https://newsapi.aylien.com/docs/working-with-entities).  (optional) 
            var sentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for finding stories whose title sentiment is the specified value.  (optional) 
            var notSentimentTitlePolarity = sentimentTitlePolarity_example;  // string | This parameter is used for excluding stories whose title sentiment is the specified value.  (optional) 
            var sentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for finding stories whose body sentiment is the specified value.  (optional) 
            var notSentimentBodyPolarity = sentimentBodyPolarity_example;  // string | This parameter is used for excluding stories whose body sentiment is the specified value.  (optional) 
            var mediaImagesCountMin = 56;  // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.  (optional) 
            var mediaImagesCountMax = 56;  // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value.  (optional) 
            var mediaImagesWidthMin = 56;  // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesWidthMax = 56;  // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value.  (optional) 
            var mediaImagesHeightMin = 56;  // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.  (optional) 
            var mediaImagesHeightMax = 56;  // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMin = 56;  // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.  (optional) 
            var mediaImagesContentLengthMax = 56;  // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value.  (optional) 
            var mediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for finding stories whose images format are the specified value.  (optional) 
            var notMediaImagesFormat = mediaImagesFormat_example;  // List<string> | This parameter is used for excluding stories whose images format are the specified value.  (optional) 
            var mediaVideosCountMin = 56;  // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.  (optional) 
            var mediaVideosCountMax = 56;  // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.  (optional) 
            var authorId = new List<int>(); // List<int> | This parameter is used for finding stories whose author id is the specified value.  (optional) 
            var notAuthorId = new List<int>(); // List<int> | This parameter is used for excluding stories whose author id is the specified value.  (optional) 
            var authorName = authorName_example;  // string | This parameter is used for finding stories whose author full name contains the specified value.  (optional) 
            var notAuthorName = authorName_example;  // string | This parameter is used for excluding stories whose author full name contains the specified value.  (optional) 
            var sourceId = new List<int>(); // List<int> | This parameter is used for finding stories whose source id is the specified value.  (optional) 
            var notSourceId = new List<int>(); // List<int> | This parameter is used for excluding stories whose source id is the specified value.  (optional) 
            var sourceName = new List<string>(); // List<string> | This parameter is used for finding stories whose source name contains the specified value.  (optional) 
            var notSourceName = new List<string>(); // List<string> | This parameter is used for excluding stories whose source name contains the specified value.  (optional) 
            var sourceDomain = new List<string>(); // List<string> | This parameter is used for finding stories whose source domain is the specified value.  (optional) 
            var notSourceDomain = new List<string>(); // List<string> | This parameter is used for excluding stories whose source domain is the specified value.  (optional) 
            var sourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsState = new List<string>(); // List<string> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLocationsCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceLocationsCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCountry = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCountry = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesState = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesState = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesCity = new List<string>(); // List<string> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesCity = new List<string>(); // List<string> | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var notSourceScopesLevel = sourceScopesLevel_example;  // List<string> | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).  (optional) 
            var sourceLinksInCountMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceLinksInCountMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).  (optional) 
            var sourceRankingsAlexaRankMin = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaRankMax = 56;  // int? | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var sourceRankingsAlexaCountry = new List<string>(); // List<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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).  (optional) 
            var socialSharesCountFacebookMin = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountFacebookMax = 56;  // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMin = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountGooglePlusMax = 56;  // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMin = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountLinkedinMax = 56;  // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMin = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.  (optional) 
            var socialSharesCountRedditMax = 56;  // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.  (optional) 

            try
            {
                // List trends
                Trends result = apiInstance.ListTrends(field, id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, linksPermalink, notLinksPermalink, language, notLanguage, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.ListTrends: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
field string This parameter is used to specify the trend field.
id List<long> This parameter is used for finding stories by story id. [optional]
notId List<long> This parameter is used for excluding stories by story id. [optional]
title string This parameter is used for finding stories whose title contains a specific keyword. It supports boolean operators. [optional]
body string This parameter is used for finding stories whose body contains a specific keyword. It supports boolean operators. [optional]
text string This parameter is used for finding stories whose title or body contains a specific keyword. It supports boolean operators. [optional]
translationsEnTitle string This parameter is used for finding stories whose translation title contains a specific keyword. It supports boolean operators. [optional]
translationsEnBody string This parameter is used for finding stories whose translation body contains a specific keyword. It supports boolean operators. [optional]
translationsEnText string This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports boolean operators. [optional]
linksPermalink List<string> This parameter is used to find stories based on their url. [optional]
notLinksPermalink List<string> This parameter is used to exclude stories based on their url. [optional]
language List<string> This parameter is used for finding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
notLanguage List<string> This parameter is used for excluding stories whose language is the specified value. It supports ISO 639-1 language codes. [optional]
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]
categoriesConfident bool? 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 List<string> This parameter is used for finding stories by categories id. You can read more about working with categories here. [optional]
notCategoriesId List<string> This parameter is used for excluding stories by categories id. You can read more about working with categories here. [optional]
categoriesLevel List<int> This parameter is used for finding stories by categories level. You can read more about working with categories here. [optional]
notCategoriesLevel List<int> This parameter is used for excluding stories by categories level. You can read more about working with categories here. [optional]
entitiesTitleText List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSentimentTitlePolarity string This parameter is used for excluding stories whose title sentiment is the specified value. [optional]
sentimentBodyPolarity string This parameter is used for finding stories whose body sentiment is the specified value. [optional]
notSentimentBodyPolarity string This parameter is used for excluding stories whose body sentiment is the specified value. [optional]
mediaImagesCountMin int? This parameter is used for finding stories whose number of images is greater than or equal to the specified value. [optional]
mediaImagesCountMax int? This parameter is used for finding stories whose number of images is less than or equal to the specified value. [optional]
mediaImagesWidthMin int? This parameter is used for finding stories whose width of images are greater than or equal to the specified value. [optional]
mediaImagesWidthMax int? This parameter is used for finding stories whose width of images are less than or equal to the specified value. [optional]
mediaImagesHeightMin int? This parameter is used for finding stories whose height of images are greater than or equal to the specified value. [optional]
mediaImagesHeightMax int? This parameter is used for finding stories whose height of images are less than or equal to the specified value. [optional]
mediaImagesContentLengthMin int? This parameter is used for finding stories whose images content length are greater than or equal to the specified value. [optional]
mediaImagesContentLengthMax int? This parameter is used for finding stories whose images content length are less than or equal to the specified value. [optional]
mediaImagesFormat List<string> This parameter is used for finding stories whose images format are the specified value. [optional]
notMediaImagesFormat List<string> This parameter is used for excluding stories whose images format are the specified value. [optional]
mediaVideosCountMin int? This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. [optional]
mediaVideosCountMax int? This parameter is used for finding stories whose number of videos is less than or equal to the specified value. [optional]
authorId List<int> This parameter is used for finding stories whose author id is the specified value. [optional]
notAuthorId List<int> 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 List<int> This parameter is used for finding stories whose source id is the specified value. [optional]
notSourceId List<int> This parameter is used for excluding stories whose source id is the specified value. [optional]
sourceName List<string> This parameter is used for finding stories whose source name contains the specified value. [optional]
notSourceName List<string> This parameter is used for excluding stories whose source name contains the specified value. [optional]
sourceDomain List<string> This parameter is used for finding stories whose source domain is the specified value. [optional]
notSourceDomain List<string> This parameter is used for excluding stories whose source domain is the specified value. [optional]
sourceLocationsCountry List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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 List<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]
notSourceScopesLevel List<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]
sourceLinksInCountMin int? 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 int? 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 int? 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 int? 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 List<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 int? This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. [optional]
socialSharesCountFacebookMax int? This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. [optional]
socialSharesCountGooglePlusMin int? This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. [optional]
socialSharesCountGooglePlusMax int? This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. [optional]
socialSharesCountLinkedinMin int? This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. [optional]
socialSharesCountLinkedinMax int? This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. [optional]
socialSharesCountRedditMin int? This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. [optional]
socialSharesCountRedditMax int? This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. [optional]

Return type

Trends

Authorization

app_id, app_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/xml

HTTP response details

Status code Description Response headers
200 An object including an array of trends * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
401 Unauthorized -
404 Not Found -
422 Unprocessable Entity -
492 Too Many Requests * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC epoch seconds.
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]