aylien_news_api 0.3.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/Gemfile +7 -1
- data/README.md +117 -4
- data/Rakefile +10 -0
- data/aylien_news_api.gemspec +24 -31
- data/docs/Author.md +12 -1
- data/docs/Autocomplete.md +10 -0
- data/docs/Autocompletes.md +9 -0
- data/docs/Category.md +19 -3
- data/docs/CategoryLinks.md +11 -1
- data/docs/CategoryTaxonomy.md +16 -0
- data/docs/Cluster.md +29 -0
- data/docs/Clusters.md +21 -0
- data/docs/Coverages.md +16 -4
- data/docs/DefaultApi.md +1310 -636
- data/docs/Entities.md +11 -1
- data/docs/Entity.md +16 -3
- data/docs/EntityLinks.md +9 -0
- data/docs/Error.md +16 -2
- data/docs/ErrorLinks.md +11 -0
- data/docs/Errors.md +9 -0
- data/docs/HistogramInterval.md +10 -0
- data/docs/Histograms.md +20 -3
- data/docs/Location.md +13 -2
- data/docs/Media.md +19 -1
- data/docs/MediaFormat.md +16 -0
- data/docs/MediaType.md +16 -0
- data/docs/Rank.md +12 -1
- data/docs/Rankings.md +9 -0
- data/docs/RelatedStories.md +18 -3
- data/docs/RepresentativeStory.md +23 -0
- data/docs/Scope.md +15 -3
- data/docs/ScopeLevel.md +16 -0
- data/docs/Sentiment.md +11 -1
- data/docs/SentimentPolarity.md +16 -0
- data/docs/Sentiments.md +12 -2
- data/docs/ShareCount.md +10 -0
- data/docs/ShareCounts.md +12 -0
- data/docs/Source.md +27 -8
- data/docs/Stories.md +17 -2
- data/docs/Story.md +48 -16
- data/docs/StoryCluster.md +14 -1
- data/docs/StoryLinks.md +14 -1
- data/docs/StoryTranslation.md +19 -0
- data/docs/StoryTranslations.md +17 -0
- data/docs/StoryTranslationsEn.md +21 -0
- data/docs/Summary.md +9 -0
- data/docs/TimeSeries.md +11 -1
- data/docs/TimeSeriesList.md +15 -3
- data/docs/Trend.md +11 -1
- data/docs/Trends.md +15 -1
- data/docs/Warning.md +21 -0
- data/git_push.sh +58 -0
- data/lib/aylien_news_api.rb +22 -14
- data/lib/aylien_news_api/api/default_api.rb +2631 -1120
- data/lib/aylien_news_api/api_client.rb +139 -105
- data/lib/aylien_news_api/api_error.rb +37 -18
- data/lib/aylien_news_api/configuration.rb +80 -42
- data/lib/aylien_news_api/models/author.rb +69 -53
- data/lib/aylien_news_api/models/autocomplete.rb +55 -39
- data/lib/aylien_news_api/models/autocompletes.rb +54 -38
- data/lib/aylien_news_api/models/category.rb +88 -97
- data/lib/aylien_news_api/models/category_links.rb +66 -50
- data/lib/aylien_news_api/models/category_taxonomy.rb +36 -0
- data/lib/aylien_news_api/models/cluster.rb +265 -0
- data/lib/aylien_news_api/models/clusters.rb +229 -0
- data/lib/aylien_news_api/models/coverages.rb +79 -75
- data/lib/aylien_news_api/models/entities.rb +67 -51
- data/lib/aylien_news_api/models/entity.rb +96 -83
- data/lib/aylien_news_api/models/entity_links.rb +54 -38
- data/lib/aylien_news_api/models/error.rb +79 -63
- data/lib/aylien_news_api/models/error_links.rb +65 -40
- data/lib/aylien_news_api/models/errors.rb +54 -38
- data/lib/aylien_news_api/models/histogram_interval.rb +55 -39
- data/lib/aylien_news_api/models/histograms.rb +99 -63
- data/lib/aylien_news_api/models/location.rb +70 -54
- data/lib/aylien_news_api/models/media.rb +97 -76
- data/lib/aylien_news_api/models/media_format.rb +44 -0
- data/lib/aylien_news_api/models/media_type.rb +36 -0
- data/lib/aylien_news_api/models/rank.rb +67 -51
- data/lib/aylien_news_api/models/rankings.rb +54 -38
- data/lib/aylien_news_api/models/related_stories.rb +87 -63
- data/lib/aylien_news_api/models/representative_story.rb +237 -0
- data/lib/aylien_news_api/models/scope.rb +76 -94
- data/lib/aylien_news_api/models/scope_level.rb +37 -0
- data/lib/aylien_news_api/models/sentiment.rb +66 -86
- data/lib/aylien_news_api/models/sentiment_polarity.rb +37 -0
- data/lib/aylien_news_api/models/sentiments.rb +65 -51
- data/lib/aylien_news_api/models/share_count.rb +55 -39
- data/lib/aylien_news_api/models/share_counts.rb +57 -41
- data/lib/aylien_news_api/models/source.rb +114 -99
- data/lib/aylien_news_api/models/stories.rb +89 -53
- data/lib/aylien_news_api/models/story.rb +191 -161
- data/lib/aylien_news_api/models/story_cluster.rb +71 -55
- data/lib/aylien_news_api/models/story_links.rb +73 -47
- data/lib/aylien_news_api/models/story_translation.rb +217 -0
- data/lib/aylien_news_api/models/story_translations.rb +207 -0
- data/lib/aylien_news_api/models/story_translations_en.rb +227 -0
- data/lib/aylien_news_api/models/summary.rb +54 -38
- data/lib/aylien_news_api/models/time_series.rb +66 -50
- data/lib/aylien_news_api/models/time_series_list.rb +75 -59
- data/lib/aylien_news_api/models/trend.rb +66 -50
- data/lib/aylien_news_api/models/trends.rb +80 -44
- data/lib/aylien_news_api/models/warning.rb +226 -0
- data/lib/aylien_news_api/version.rb +12 -14
- data/spec/api/default_api_spec.rb +620 -284
- data/spec/api_client_spec.rb +43 -161
- data/spec/configuration_spec.rb +22 -19
- data/spec/models/author_spec.rb +21 -34
- data/spec/models/autocomplete_spec.rb +17 -26
- data/spec/models/autocompletes_spec.rb +16 -21
- data/spec/models/category_links_spec.rb +19 -28
- data/spec/models/category_spec.rb +31 -50
- data/spec/models/category_taxonomy_spec.rb +35 -0
- data/spec/models/cluster_spec.rb +77 -0
- data/spec/models/clusters_spec.rb +53 -0
- data/spec/models/coverages_spec.rb +24 -45
- data/spec/models/entities_spec.rb +19 -28
- data/spec/models/entity_links_spec.rb +16 -21
- data/spec/models/entity_spec.rb +25 -46
- data/spec/models/error_links_spec.rb +22 -21
- data/spec/models/error_spec.rb +27 -52
- data/spec/models/errors_spec.rb +16 -21
- data/spec/models/histogram_interval_spec.rb +17 -26
- data/spec/models/histograms_spec.rb +36 -45
- data/spec/models/location_spec.rb +21 -34
- data/spec/models/media_format_spec.rb +35 -0
- data/spec/models/media_spec.rb +41 -26
- data/spec/models/media_type_spec.rb +35 -0
- data/spec/models/rank_spec.rb +20 -21
- data/spec/models/rankings_spec.rb +15 -16
- data/spec/models/related_stories_spec.rb +33 -38
- data/spec/models/representative_story_spec.rb +59 -0
- data/spec/models/scope_level_spec.rb +35 -0
- data/spec/models/scope_spec.rb +23 -40
- data/spec/models/sentiment_polarity_spec.rb +35 -0
- data/spec/models/sentiment_spec.rb +17 -26
- data/spec/models/sentiments_spec.rb +19 -28
- data/spec/models/share_count_spec.rb +17 -26
- data/spec/models/share_counts_spec.rb +19 -36
- data/spec/models/source_spec.rb +54 -49
- data/spec/models/stories_spec.rb +32 -33
- data/spec/models/story_cluster_spec.rb +23 -44
- data/spec/models/story_links_spec.rb +25 -32
- data/spec/models/story_spec.rb +65 -134
- data/spec/models/story_translation_spec.rb +47 -0
- data/spec/models/story_translations_en_spec.rb +53 -0
- data/spec/models/story_translations_spec.rb +41 -0
- data/spec/models/summary_spec.rb +16 -21
- data/spec/models/time_series_list_spec.rb +22 -39
- data/spec/models/time_series_spec.rb +19 -28
- data/spec/models/trend_spec.rb +19 -28
- data/spec/models/trends_spec.rb +30 -27
- data/spec/models/warning_spec.rb +53 -0
- data/spec/spec_helper.rb +11 -13
- metadata +92 -195
- data/Gemfile.lock +0 -65
- data/LICENSE +0 -13
- data/aylien_news_api-0.2.0.gem +0 -0
data/docs/DefaultApi.md
CHANGED
@@ -1,48 +1,52 @@
|
|
1
1
|
# AylienNewsApi::DefaultApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.
|
3
|
+
All URIs are relative to *https://api.aylien.com/news*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
8
|
-
[**
|
8
|
+
[**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
9
9
|
[**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
10
|
-
[**
|
10
|
+
[**list_related_stories_get**](DefaultApi.md#list_related_stories_get) | **GET** /related_stories |
|
11
|
+
[**list_related_stories_post**](DefaultApi.md#list_related_stories_post) | **POST** /related_stories |
|
11
12
|
[**list_stories**](DefaultApi.md#list_stories) | **GET** /stories | List Stories
|
12
13
|
[**list_time_series**](DefaultApi.md#list_time_series) | **GET** /time_series | List time series
|
13
14
|
[**list_trends**](DefaultApi.md#list_trends) | **GET** /trends | List trends
|
14
15
|
|
15
16
|
|
16
|
-
|
17
|
+
|
18
|
+
## list_autocompletes
|
19
|
+
|
17
20
|
> Autocompletes list_autocompletes(type, term, opts)
|
18
21
|
|
19
22
|
List autocompletes
|
20
23
|
|
21
|
-
|
24
|
+
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.
|
22
25
|
|
23
26
|
### Example
|
27
|
+
|
24
28
|
```ruby
|
25
29
|
# load the gem
|
26
30
|
require 'aylien_news_api'
|
27
|
-
|
28
31
|
# setup authorization
|
29
32
|
AylienNewsApi.configure do |config|
|
30
33
|
# Configure API key authorization: app_id
|
31
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
34
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
32
37
|
|
33
38
|
# Configure API key authorization: app_key
|
34
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
39
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
40
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
41
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
35
42
|
end
|
36
43
|
|
37
44
|
api_instance = AylienNewsApi::DefaultApi.new
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
opts = {
|
44
|
-
language: "en", # 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.
|
45
|
-
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
45
|
+
type = 'source_names' # String | This parameter is used for defining the type of autocompletes.
|
46
|
+
term = 'News' # String | This parameter is used for finding autocomplete objects that contain the specified value.
|
47
|
+
opts = {
|
48
|
+
language: 'en', # 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.
|
49
|
+
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
46
50
|
}
|
47
51
|
|
48
52
|
begin
|
@@ -56,12 +60,13 @@ end
|
|
56
60
|
|
57
61
|
### Parameters
|
58
62
|
|
63
|
+
|
59
64
|
Name | Type | Description | Notes
|
60
65
|
------------- | ------------- | ------------- | -------------
|
61
|
-
**type** | **String**| This parameter is used for defining the type of autocompletes.
|
62
|
-
**term** | **String**| This parameter is used for finding autocomplete objects that contain the specified value.
|
63
|
-
**language** | **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.
|
64
|
-
**per_page** | **Integer**| This parameter is used for specifying number of items in each page.
|
66
|
+
**type** | **String**| This parameter is used for defining the type of autocompletes. |
|
67
|
+
**term** | **String**| This parameter is used for finding autocomplete objects that contain the specified value. |
|
68
|
+
**language** | **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']
|
69
|
+
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
65
70
|
|
66
71
|
### Return type
|
67
72
|
|
@@ -69,238 +74,227 @@ Name | Type | Description | Notes
|
|
69
74
|
|
70
75
|
### Authorization
|
71
76
|
|
72
|
-
[
|
77
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
73
78
|
|
74
79
|
### HTTP request headers
|
75
80
|
|
76
|
-
|
77
|
-
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json, text/xml
|
78
83
|
|
79
84
|
|
85
|
+
## list_clusters
|
80
86
|
|
81
|
-
|
82
|
-
> Coverages list_coverages(opts)
|
87
|
+
> Clusters list_clusters(opts)
|
83
88
|
|
84
|
-
List
|
89
|
+
List Clusters
|
85
90
|
|
86
|
-
|
91
|
+
The clusters endpoint is used to return clusters based on parameters you set in your query.
|
87
92
|
|
88
93
|
### Example
|
94
|
+
|
89
95
|
```ruby
|
90
96
|
# load the gem
|
91
97
|
require 'aylien_news_api'
|
92
|
-
|
93
98
|
# setup authorization
|
94
99
|
AylienNewsApi.configure do |config|
|
95
100
|
# Configure API key authorization: app_id
|
96
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
101
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
103
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
97
104
|
|
98
105
|
# Configure API key authorization: app_key
|
99
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
106
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
108
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
100
109
|
end
|
101
110
|
|
102
111
|
api_instance = AylienNewsApi::DefaultApi.new
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories.
|
122
|
-
sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
123
|
-
sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
124
|
-
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
125
|
-
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
126
|
-
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
127
|
-
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
128
|
-
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
129
|
-
author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
|
130
|
-
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
131
|
-
source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
132
|
-
source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
133
|
-
source_locations_country: ["source_locations_country_example"], # Array<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).
|
134
|
-
source_locations_state: ["source_locations_state_example"], # Array<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).
|
135
|
-
source_locations_city: ["source_locations_city_example"], # Array<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).
|
136
|
-
source_scopes_country: ["source_scopes_country_example"], # Array<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).
|
137
|
-
source_scopes_state: ["source_scopes_state_example"], # Array<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).
|
138
|
-
source_scopes_city: ["source_scopes_city_example"], # Array<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).
|
139
|
-
source_scopes_level: ["source_scopes_level_example"], # Array<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).
|
140
|
-
source_links_in_count_min: 56, # Integer | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
141
|
-
source_links_in_count_max: 56, # Integer | 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](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
142
|
-
source_rankings_alexa_rank_min: 56, # Integer | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
143
|
-
source_rankings_alexa_rank_max: 56, # Integer | 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
144
|
-
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<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](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
145
|
-
cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
|
146
|
-
cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
147
|
-
_return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
|
148
|
-
story_id: 789, # Integer | A story id
|
149
|
-
story_url: "story_url_example", # String | An article or webpage
|
150
|
-
story_title: "story_title_example", # String | Title of the article
|
151
|
-
story_body: "story_body_example", # String | Body of the article
|
152
|
-
story_published_at: DateTime.parse("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).
|
153
|
-
story_language: "auto", # 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.
|
154
|
-
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
112
|
+
opts = {
|
113
|
+
id: [56], # Array<Integer> | This parameter is used for finding clusters by cluster id.
|
114
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding clusters by cluster id.
|
115
|
+
story_count_min: 56, # Integer | This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them.
|
116
|
+
story_count_max: 56, # Integer | This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them.
|
117
|
+
time_start: 'time_start_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).
|
118
|
+
time_end: 'time_end_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).
|
119
|
+
earliest_story_start: 'earliest_story_start_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).
|
120
|
+
earliest_story_end: 'earliest_story_end_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).
|
121
|
+
latest_story_start: 'latest_story_start_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).
|
122
|
+
latest_story_end: 'latest_story_end_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).
|
123
|
+
location_country: ['location_country_example'], # Array<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).
|
124
|
+
not_location_country: ['location_country_example'], # Array<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).
|
125
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
126
|
+
sort_by: 'published_at', # 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).
|
127
|
+
sort_direction: 'desc', # 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).
|
128
|
+
cursor: '*', # 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).
|
129
|
+
per_page: 10 # Integer | 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)
|
155
130
|
}
|
156
131
|
|
157
132
|
begin
|
158
|
-
#List
|
159
|
-
result = api_instance.
|
133
|
+
#List Clusters
|
134
|
+
result = api_instance.list_clusters(opts)
|
160
135
|
p result
|
161
136
|
rescue AylienNewsApi::ApiError => e
|
162
|
-
puts "Exception when calling DefaultApi->
|
137
|
+
puts "Exception when calling DefaultApi->list_clusters: #{e}"
|
163
138
|
end
|
164
139
|
```
|
165
140
|
|
166
141
|
### Parameters
|
167
142
|
|
143
|
+
|
168
144
|
Name | Type | Description | Notes
|
169
145
|
------------- | ------------- | ------------- | -------------
|
170
|
-
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding
|
171
|
-
**
|
172
|
-
**
|
173
|
-
**
|
174
|
-
**
|
175
|
-
**
|
176
|
-
**
|
177
|
-
**
|
178
|
-
**
|
179
|
-
**
|
180
|
-
**
|
181
|
-
**
|
182
|
-
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. | [optional]
|
183
|
-
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. | [optional]
|
184
|
-
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. | [optional]
|
185
|
-
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. | [optional]
|
186
|
-
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. | [optional]
|
187
|
-
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
188
|
-
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
189
|
-
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
190
|
-
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
191
|
-
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
192
|
-
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
193
|
-
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
194
|
-
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
195
|
-
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
196
|
-
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
197
|
-
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
198
|
-
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
199
|
-
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
200
|
-
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
201
|
-
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
202
|
-
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
203
|
-
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
204
|
-
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
205
|
-
**source_links_in_count_min** | **Integer**| 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](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
206
|
-
**source_links_in_count_max** | **Integer**| 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](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
207
|
-
**source_rankings_alexa_rank_min** | **Integer**| 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
208
|
-
**source_rankings_alexa_rank_max** | **Integer**| 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
209
|
-
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
210
|
-
**cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
|
211
|
-
**cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
|
146
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding clusters by cluster id. | [optional]
|
147
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding clusters by cluster id. | [optional]
|
148
|
+
**story_count_min** | **Integer**| This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them. | [optional]
|
149
|
+
**story_count_max** | **Integer**| This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them. | [optional]
|
150
|
+
**time_start** | **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]
|
151
|
+
**time_end** | **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]
|
152
|
+
**earliest_story_start** | **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]
|
153
|
+
**earliest_story_end** | **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]
|
154
|
+
**latest_story_start** | **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]
|
155
|
+
**latest_story_end** | **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]
|
156
|
+
**location_country** | [**Array<String>**](String.md)| 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]
|
157
|
+
**not_location_country** | [**Array<String>**](String.md)| 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]
|
212
158
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
213
|
-
**
|
214
|
-
**
|
215
|
-
**
|
216
|
-
**
|
217
|
-
**story_published_at** | **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]
|
218
|
-
**story_language** | **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]
|
219
|
-
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
159
|
+
**sort_by** | **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']
|
160
|
+
**sort_direction** | **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']
|
161
|
+
**cursor** | **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 '*']
|
162
|
+
**per_page** | **Integer**| 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]
|
220
163
|
|
221
164
|
### Return type
|
222
165
|
|
223
|
-
[**
|
166
|
+
[**Clusters**](Clusters.md)
|
224
167
|
|
225
168
|
### Authorization
|
226
169
|
|
227
|
-
[
|
170
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
228
171
|
|
229
172
|
### HTTP request headers
|
230
173
|
|
231
|
-
|
232
|
-
|
174
|
+
- **Content-Type**: Not defined
|
175
|
+
- **Accept**: application/json, text/xml
|
233
176
|
|
234
177
|
|
178
|
+
## list_histograms
|
235
179
|
|
236
|
-
# **list_histograms**
|
237
180
|
> Histograms list_histograms(opts)
|
238
181
|
|
239
182
|
List histograms
|
240
183
|
|
241
|
-
|
184
|
+
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.
|
242
185
|
|
243
186
|
### Example
|
187
|
+
|
244
188
|
```ruby
|
245
189
|
# load the gem
|
246
190
|
require 'aylien_news_api'
|
247
|
-
|
248
191
|
# setup authorization
|
249
192
|
AylienNewsApi.configure do |config|
|
250
193
|
# Configure API key authorization: app_id
|
251
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
194
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
195
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
196
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
252
197
|
|
253
198
|
# Configure API key authorization: app_key
|
254
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
199
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
201
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
255
202
|
end
|
256
203
|
|
257
204
|
api_instance = AylienNewsApi::DefaultApi.new
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
title:
|
262
|
-
body:
|
263
|
-
text:
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
205
|
+
opts = {
|
206
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
207
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
208
|
+
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).
|
209
|
+
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).
|
210
|
+
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).
|
211
|
+
translations_en_title: 'translations_en_title_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).
|
212
|
+
translations_en_body: 'translations_en_body_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).
|
213
|
+
translations_en_text: 'translations_en_text_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).
|
214
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
215
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
216
|
+
language: ['language_example'], # Array<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.
|
217
|
+
not_language: ['language_example'], # Array<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.
|
218
|
+
published_at_start: 'published_at_start_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).
|
219
|
+
published_at_end: 'published_at_end_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).
|
220
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
221
|
+
categories_confident: true, # Boolean | 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).
|
222
|
+
categories_id: ['categories_id_example'], # Array<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).
|
223
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
224
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
225
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
226
|
+
categories_level: [56], # Array<Integer> | 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).
|
227
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
228
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
229
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
230
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
231
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
232
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
233
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
234
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
235
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
236
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
237
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
238
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
239
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
240
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
241
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
242
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
243
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
244
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
245
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
246
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
247
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
248
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
249
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
250
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
251
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
252
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
253
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
254
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
255
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
256
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
257
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
258
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
259
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
260
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
261
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
262
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
263
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
264
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
265
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
266
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
267
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
268
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
269
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
270
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
271
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
272
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
273
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
274
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
275
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
276
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
277
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
278
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
279
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
280
|
+
source_links_in_count_min: 56, # Integer | 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).
|
281
|
+
source_links_in_count_max: 56, # Integer | 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).
|
282
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
283
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
284
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
285
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
286
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
287
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
288
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
289
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
290
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
291
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
292
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
293
|
+
clusters: ['clusters_example'], # Array<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).
|
294
|
+
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
295
|
+
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
296
|
+
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
297
|
+
field: 'social_shares_count' # String | This parameter is used for specifying the y-axis variable for the histogram.
|
304
298
|
}
|
305
299
|
|
306
300
|
begin
|
@@ -314,52 +308,101 @@ end
|
|
314
308
|
|
315
309
|
### Parameters
|
316
310
|
|
311
|
+
|
317
312
|
Name | Type | Description | Notes
|
318
313
|
------------- | ------------- | ------------- | -------------
|
319
|
-
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding
|
320
|
-
**
|
321
|
-
**
|
322
|
-
**
|
323
|
-
**
|
324
|
-
**
|
325
|
-
**
|
326
|
-
**
|
327
|
-
**
|
328
|
-
**
|
329
|
-
**
|
330
|
-
**
|
331
|
-
**
|
332
|
-
**
|
333
|
-
**
|
334
|
-
**
|
335
|
-
**
|
336
|
-
**
|
337
|
-
**
|
338
|
-
**
|
339
|
-
**
|
340
|
-
**
|
341
|
-
**
|
342
|
-
**
|
343
|
-
**
|
344
|
-
**
|
345
|
-
**
|
346
|
-
**
|
347
|
-
**
|
348
|
-
**
|
349
|
-
**
|
350
|
-
**
|
351
|
-
**
|
352
|
-
**
|
353
|
-
**
|
354
|
-
**
|
355
|
-
**
|
356
|
-
**
|
357
|
-
**
|
358
|
-
**
|
359
|
-
**
|
360
|
-
**
|
361
|
-
**
|
362
|
-
**
|
314
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
315
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
316
|
+
**title** | **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]
|
317
|
+
**body** | **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]
|
318
|
+
**text** | **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]
|
319
|
+
**translations_en_title** | **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]
|
320
|
+
**translations_en_body** | **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]
|
321
|
+
**translations_en_text** | **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]
|
322
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
323
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
324
|
+
**language** | [**Array<String>**](String.md)| 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]
|
325
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
326
|
+
**published_at_start** | **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]
|
327
|
+
**published_at_end** | **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]
|
328
|
+
**categories_taxonomy** | **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]
|
329
|
+
**categories_confident** | **Boolean**| 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]
|
330
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
331
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
332
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
333
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
334
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
335
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
336
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
337
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
338
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
339
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
340
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
341
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
342
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
343
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
344
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
345
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
346
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
347
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
348
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
349
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
350
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
351
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
352
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
353
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
354
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
355
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
356
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
357
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
358
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
359
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
360
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
361
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
362
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
363
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
364
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
365
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
366
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
367
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
368
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
369
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
370
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
371
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
372
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
373
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
374
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
375
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
376
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
377
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
378
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
379
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
380
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
381
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
382
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
383
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
384
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
385
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
386
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
387
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
388
|
+
**source_links_in_count_min** | **Integer**| 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]
|
389
|
+
**source_links_in_count_max** | **Integer**| 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]
|
390
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
391
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
392
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
393
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
394
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
395
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
396
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
397
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
398
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
399
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
400
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
401
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
402
|
+
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
403
|
+
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
404
|
+
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
405
|
+
**field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to 'social_shares_count']
|
363
406
|
|
364
407
|
### Return type
|
365
408
|
|
@@ -367,154 +410,495 @@ Name | Type | Description | Notes
|
|
367
410
|
|
368
411
|
### Authorization
|
369
412
|
|
370
|
-
[
|
413
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
371
414
|
|
372
415
|
### HTTP request headers
|
373
416
|
|
374
|
-
|
375
|
-
|
417
|
+
- **Content-Type**: Not defined
|
418
|
+
- **Accept**: application/json, text/xml
|
376
419
|
|
377
420
|
|
421
|
+
## list_related_stories_get
|
378
422
|
|
379
|
-
|
380
|
-
> RelatedStories list_related_stories(opts)
|
423
|
+
> RelatedStories list_related_stories_get(opts)
|
381
424
|
|
382
|
-
List related stories
|
383
425
|
|
384
|
-
This endpoint is used for finding related stories based on the parameters provided. The maximum number of related stories returned is 100.
|
385
426
|
|
386
427
|
### Example
|
428
|
+
|
387
429
|
```ruby
|
388
430
|
# load the gem
|
389
431
|
require 'aylien_news_api'
|
390
|
-
|
391
432
|
# setup authorization
|
392
433
|
AylienNewsApi.configure do |config|
|
393
434
|
# Configure API key authorization: app_id
|
394
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
435
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
436
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
437
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
395
438
|
|
396
439
|
# Configure API key authorization: app_key
|
397
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
440
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
441
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
442
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
398
443
|
end
|
399
444
|
|
400
445
|
api_instance = AylienNewsApi::DefaultApi.new
|
446
|
+
opts = {
|
447
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
448
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
449
|
+
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).
|
450
|
+
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).
|
451
|
+
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).
|
452
|
+
translations_en_title: 'translations_en_title_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).
|
453
|
+
translations_en_body: 'translations_en_body_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).
|
454
|
+
translations_en_text: 'translations_en_text_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).
|
455
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
456
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
457
|
+
language: ['language_example'], # Array<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.
|
458
|
+
not_language: ['language_example'], # Array<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.
|
459
|
+
published_at_start: 'published_at_start_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).
|
460
|
+
published_at_end: 'published_at_end_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).
|
461
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
462
|
+
categories_confident: true, # Boolean | 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).
|
463
|
+
categories_id: ['categories_id_example'], # Array<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).
|
464
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
465
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
466
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
467
|
+
categories_level: [56], # Array<Integer> | 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).
|
468
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
469
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
470
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
471
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
472
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
473
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
474
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
475
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
476
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
477
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
478
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
479
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
480
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
481
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
482
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
483
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
484
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
485
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
486
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
487
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
488
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
489
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
490
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
491
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
492
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
493
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
494
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
495
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
496
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
497
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
498
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
499
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
500
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
501
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
502
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
503
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
504
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
505
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
506
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
507
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
508
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
509
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
510
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
511
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
512
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
513
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
514
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
515
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
516
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
517
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
518
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
519
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
520
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
521
|
+
source_links_in_count_min: 56, # Integer | 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).
|
522
|
+
source_links_in_count_max: 56, # Integer | 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).
|
523
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
524
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
525
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
526
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
527
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
528
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
529
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
530
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
531
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
532
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
533
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
534
|
+
clusters: ['clusters_example'], # Array<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).
|
535
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
536
|
+
story_id: 56, # Integer | A story id
|
537
|
+
story_url: 'story_url_example', # String | An article or webpage
|
538
|
+
story_title: 'story_title_example', # String | Title of the article
|
539
|
+
story_body: 'story_body_example', # String | Body of the article
|
540
|
+
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
541
|
+
story_language: 'auto', # 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.
|
542
|
+
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
543
|
+
}
|
544
|
+
|
545
|
+
begin
|
546
|
+
result = api_instance.list_related_stories_get(opts)
|
547
|
+
p result
|
548
|
+
rescue AylienNewsApi::ApiError => e
|
549
|
+
puts "Exception when calling DefaultApi->list_related_stories_get: #{e}"
|
550
|
+
end
|
551
|
+
```
|
552
|
+
|
553
|
+
### Parameters
|
554
|
+
|
555
|
+
|
556
|
+
Name | Type | Description | Notes
|
557
|
+
------------- | ------------- | ------------- | -------------
|
558
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
559
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
560
|
+
**title** | **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]
|
561
|
+
**body** | **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]
|
562
|
+
**text** | **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]
|
563
|
+
**translations_en_title** | **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]
|
564
|
+
**translations_en_body** | **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]
|
565
|
+
**translations_en_text** | **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]
|
566
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
567
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
568
|
+
**language** | [**Array<String>**](String.md)| 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]
|
569
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
570
|
+
**published_at_start** | **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]
|
571
|
+
**published_at_end** | **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]
|
572
|
+
**categories_taxonomy** | **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]
|
573
|
+
**categories_confident** | **Boolean**| 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]
|
574
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
575
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
576
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
577
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
578
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
579
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
580
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
581
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
582
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
583
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
584
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
585
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
586
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
587
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
588
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
589
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
590
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
591
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
592
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
593
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
594
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
595
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
596
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
597
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
598
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
599
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
600
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
601
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
602
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
603
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
604
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
605
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
606
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
607
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
608
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
609
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
610
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
611
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
612
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
613
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
614
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
615
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
616
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
617
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
618
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
619
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
620
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
621
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
622
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
623
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
624
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
625
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
626
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
627
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
628
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
629
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
630
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
631
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
632
|
+
**source_links_in_count_min** | **Integer**| 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]
|
633
|
+
**source_links_in_count_max** | **Integer**| 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]
|
634
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
635
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
636
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
637
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
638
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
639
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
640
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
641
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
642
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
643
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
644
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
645
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
646
|
+
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
647
|
+
**story_id** | **Integer**| A story id | [optional]
|
648
|
+
**story_url** | **String**| An article or webpage | [optional]
|
649
|
+
**story_title** | **String**| Title of the article | [optional]
|
650
|
+
**story_body** | **String**| Body of the article | [optional]
|
651
|
+
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
652
|
+
**story_language** | **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']
|
653
|
+
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
654
|
+
|
655
|
+
### Return type
|
401
656
|
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
657
|
+
[**RelatedStories**](RelatedStories.md)
|
658
|
+
|
659
|
+
### Authorization
|
660
|
+
|
661
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
662
|
+
|
663
|
+
### HTTP request headers
|
664
|
+
|
665
|
+
- **Content-Type**: Not defined
|
666
|
+
- **Accept**: application/json, text/xml
|
667
|
+
|
668
|
+
|
669
|
+
## list_related_stories_post
|
670
|
+
|
671
|
+
> RelatedStories list_related_stories_post(opts)
|
672
|
+
|
673
|
+
|
674
|
+
|
675
|
+
### Example
|
676
|
+
|
677
|
+
```ruby
|
678
|
+
# load the gem
|
679
|
+
require 'aylien_news_api'
|
680
|
+
# setup authorization
|
681
|
+
AylienNewsApi.configure do |config|
|
682
|
+
# Configure API key authorization: app_id
|
683
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
684
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
685
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
686
|
+
|
687
|
+
# Configure API key authorization: app_key
|
688
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
689
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
690
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
691
|
+
end
|
692
|
+
|
693
|
+
api_instance = AylienNewsApi::DefaultApi.new
|
694
|
+
opts = {
|
695
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
696
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
697
|
+
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).
|
698
|
+
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).
|
699
|
+
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).
|
700
|
+
translations_en_title: 'translations_en_title_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).
|
701
|
+
translations_en_body: 'translations_en_body_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).
|
702
|
+
translations_en_text: 'translations_en_text_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).
|
703
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
704
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
705
|
+
language: ['language_example'], # Array<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.
|
706
|
+
not_language: ['language_example'], # Array<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.
|
707
|
+
published_at_start: 'published_at_start_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).
|
708
|
+
published_at_end: 'published_at_end_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).
|
709
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
710
|
+
categories_confident: true, # Boolean | 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).
|
711
|
+
categories_id: ['categories_id_example'], # Array<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).
|
712
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
713
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
714
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
715
|
+
categories_level: [56], # Array<Integer> | 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).
|
716
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
717
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
718
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
719
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
720
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
721
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
722
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
723
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
724
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
725
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
726
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
727
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
728
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
729
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
730
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
731
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
732
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
733
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
734
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
735
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
736
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
737
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
738
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
739
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
740
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
741
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
742
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
743
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
744
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
745
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
746
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
747
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
748
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
749
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
750
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
751
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
752
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
753
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
754
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
755
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
756
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
757
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
758
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
759
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
760
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
761
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
762
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
763
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
764
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
765
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
766
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
767
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
768
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
769
|
+
source_links_in_count_min: 56, # Integer | 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).
|
770
|
+
source_links_in_count_max: 56, # Integer | 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).
|
771
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
772
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
773
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
774
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
775
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
776
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
777
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
778
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
779
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
780
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
781
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
782
|
+
clusters: ['clusters_example'], # Array<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).
|
783
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
784
|
+
story_id: 56, # Integer | A story id
|
785
|
+
story_url: 'story_url_example', # String | An article or webpage
|
786
|
+
story_title: 'story_title_example', # String | Title of the article
|
787
|
+
story_body: 'story_body_example', # String | Body of the article
|
788
|
+
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
789
|
+
story_language: 'auto', # 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.
|
790
|
+
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
453
791
|
}
|
454
792
|
|
455
793
|
begin
|
456
|
-
|
457
|
-
result = api_instance.list_related_stories(opts)
|
794
|
+
result = api_instance.list_related_stories_post(opts)
|
458
795
|
p result
|
459
796
|
rescue AylienNewsApi::ApiError => e
|
460
|
-
puts "Exception when calling DefaultApi->
|
797
|
+
puts "Exception when calling DefaultApi->list_related_stories_post: #{e}"
|
461
798
|
end
|
462
799
|
```
|
463
800
|
|
464
801
|
### Parameters
|
465
802
|
|
803
|
+
|
466
804
|
Name | Type | Description | Notes
|
467
805
|
------------- | ------------- | ------------- | -------------
|
468
|
-
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding
|
469
|
-
**
|
470
|
-
**
|
471
|
-
**
|
472
|
-
**
|
473
|
-
**
|
474
|
-
**
|
475
|
-
**
|
476
|
-
**
|
477
|
-
**
|
478
|
-
**
|
479
|
-
**
|
480
|
-
**
|
481
|
-
**
|
482
|
-
**
|
483
|
-
**
|
484
|
-
**
|
485
|
-
**
|
486
|
-
**
|
487
|
-
**
|
488
|
-
**
|
489
|
-
**
|
490
|
-
**
|
491
|
-
**
|
492
|
-
**
|
493
|
-
**
|
494
|
-
**
|
495
|
-
**
|
496
|
-
**
|
497
|
-
**
|
498
|
-
**
|
499
|
-
**
|
500
|
-
**
|
501
|
-
**
|
502
|
-
**
|
503
|
-
**
|
504
|
-
**
|
505
|
-
**
|
506
|
-
**
|
507
|
-
**
|
508
|
-
**
|
509
|
-
**
|
806
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
807
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
808
|
+
**title** | **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]
|
809
|
+
**body** | **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]
|
810
|
+
**text** | **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]
|
811
|
+
**translations_en_title** | **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]
|
812
|
+
**translations_en_body** | **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]
|
813
|
+
**translations_en_text** | **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]
|
814
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
815
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
816
|
+
**language** | [**Array<String>**](String.md)| 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]
|
817
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
818
|
+
**published_at_start** | **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]
|
819
|
+
**published_at_end** | **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]
|
820
|
+
**categories_taxonomy** | **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]
|
821
|
+
**categories_confident** | **Boolean**| 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]
|
822
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
823
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
824
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
825
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
826
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
827
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
828
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
829
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
830
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
831
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
832
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
833
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
834
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
835
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
836
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
837
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
838
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
839
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
840
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
841
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
842
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
843
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
844
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
845
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
846
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
847
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
848
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
849
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
850
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
851
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
852
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
853
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
854
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
855
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
856
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
857
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
858
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
859
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
860
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
861
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
862
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
863
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
864
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
865
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
866
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
867
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
868
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
869
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
870
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
871
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
872
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
873
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
874
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
875
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
876
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
877
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
878
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
879
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
880
|
+
**source_links_in_count_min** | **Integer**| 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]
|
881
|
+
**source_links_in_count_max** | **Integer**| 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]
|
882
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
883
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
884
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
885
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
886
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
887
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
888
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
889
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
890
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
891
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
892
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
893
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
510
894
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
511
895
|
**story_id** | **Integer**| A story id | [optional]
|
512
896
|
**story_url** | **String**| An article or webpage | [optional]
|
513
897
|
**story_title** | **String**| Title of the article | [optional]
|
514
898
|
**story_body** | **String**| Body of the article | [optional]
|
515
|
-
**boost_by** | **String**| This parameter is used for boosting the result by the specified value.
|
516
|
-
**story_language** | **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.
|
517
|
-
**per_page** | **Integer**| This parameter is used for specifying number of items in each page.
|
899
|
+
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
900
|
+
**story_language** | **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']
|
901
|
+
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
518
902
|
|
519
903
|
### Return type
|
520
904
|
|
@@ -522,86 +906,135 @@ Name | Type | Description | Notes
|
|
522
906
|
|
523
907
|
### Authorization
|
524
908
|
|
525
|
-
[
|
909
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
526
910
|
|
527
911
|
### HTTP request headers
|
528
912
|
|
529
|
-
|
530
|
-
|
913
|
+
- **Content-Type**: Not defined
|
914
|
+
- **Accept**: application/json, text/xml
|
531
915
|
|
532
916
|
|
917
|
+
## list_stories
|
533
918
|
|
534
|
-
# **list_stories**
|
535
919
|
> Stories list_stories(opts)
|
536
920
|
|
537
921
|
List Stories
|
538
922
|
|
539
|
-
|
923
|
+
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.
|
540
924
|
|
541
925
|
### Example
|
926
|
+
|
542
927
|
```ruby
|
543
928
|
# load the gem
|
544
929
|
require 'aylien_news_api'
|
545
|
-
|
546
930
|
# setup authorization
|
547
931
|
AylienNewsApi.configure do |config|
|
548
932
|
# Configure API key authorization: app_id
|
549
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
933
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
934
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
935
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
550
936
|
|
551
937
|
# Configure API key authorization: app_key
|
552
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
938
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
939
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
940
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
553
941
|
end
|
554
942
|
|
555
943
|
api_instance = AylienNewsApi::DefaultApi.new
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
title:
|
560
|
-
body:
|
561
|
-
text:
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
944
|
+
opts = {
|
945
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
946
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
947
|
+
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).
|
948
|
+
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).
|
949
|
+
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).
|
950
|
+
translations_en_title: 'translations_en_title_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).
|
951
|
+
translations_en_body: 'translations_en_body_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).
|
952
|
+
translations_en_text: 'translations_en_text_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).
|
953
|
+
language: ['language_example'], # Array<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.
|
954
|
+
not_language: ['language_example'], # Array<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.
|
955
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
956
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
957
|
+
published_at_start: 'published_at_start_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).
|
958
|
+
published_at_end: 'published_at_end_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).
|
959
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
960
|
+
categories_confident: true, # Boolean | 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).
|
961
|
+
categories_id: ['categories_id_example'], # Array<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).
|
962
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
963
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
964
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
965
|
+
categories_level: [56], # Array<Integer> | 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).
|
966
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
967
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
968
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
969
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
970
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
971
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
972
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
973
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
974
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
975
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
976
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
977
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
978
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
979
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
980
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
981
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
982
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
983
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
984
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
985
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
986
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
987
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
988
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
989
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
990
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
991
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
992
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
993
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
994
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
995
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
996
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
997
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
998
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
999
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
1000
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
1001
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
1002
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
1003
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
1004
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
1005
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
1006
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
1007
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
1008
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
1009
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
1010
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
1011
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1012
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1013
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1014
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1015
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1016
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1017
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1018
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1019
|
+
source_links_in_count_min: 56, # Integer | 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).
|
1020
|
+
source_links_in_count_max: 56, # Integer | 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).
|
1021
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
1022
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
1023
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
1024
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
1025
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
1026
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
1027
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
1028
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
1029
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
1030
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1031
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1032
|
+
clusters: ['clusters_example'], # Array<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).
|
1033
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
1034
|
+
sort_by: 'published_at', # 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).
|
1035
|
+
sort_direction: 'desc', # 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).
|
1036
|
+
cursor: '*', # 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).
|
1037
|
+
per_page: 10 # Integer | 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)
|
605
1038
|
}
|
606
1039
|
|
607
1040
|
begin
|
@@ -615,55 +1048,102 @@ end
|
|
615
1048
|
|
616
1049
|
### Parameters
|
617
1050
|
|
1051
|
+
|
618
1052
|
Name | Type | Description | Notes
|
619
1053
|
------------- | ------------- | ------------- | -------------
|
620
|
-
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding
|
621
|
-
**
|
622
|
-
**
|
623
|
-
**
|
624
|
-
**
|
625
|
-
**
|
626
|
-
**
|
627
|
-
**
|
628
|
-
**
|
629
|
-
**
|
630
|
-
**
|
631
|
-
**
|
632
|
-
**
|
633
|
-
**
|
634
|
-
**
|
635
|
-
**
|
636
|
-
**
|
637
|
-
**
|
638
|
-
**
|
639
|
-
**
|
640
|
-
**
|
641
|
-
**
|
642
|
-
**
|
643
|
-
**
|
644
|
-
**
|
645
|
-
**
|
646
|
-
**
|
647
|
-
**
|
648
|
-
**
|
649
|
-
**
|
650
|
-
**
|
651
|
-
**
|
652
|
-
**
|
653
|
-
**
|
654
|
-
**
|
655
|
-
**
|
656
|
-
**
|
657
|
-
**
|
658
|
-
**
|
659
|
-
**
|
660
|
-
**
|
661
|
-
**
|
1054
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
1055
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
1056
|
+
**title** | **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]
|
1057
|
+
**body** | **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]
|
1058
|
+
**text** | **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]
|
1059
|
+
**translations_en_title** | **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]
|
1060
|
+
**translations_en_body** | **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]
|
1061
|
+
**translations_en_text** | **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]
|
1062
|
+
**language** | [**Array<String>**](String.md)| 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]
|
1063
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
1064
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
1065
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
1066
|
+
**published_at_start** | **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]
|
1067
|
+
**published_at_end** | **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]
|
1068
|
+
**categories_taxonomy** | **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]
|
1069
|
+
**categories_confident** | **Boolean**| 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]
|
1070
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
1071
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
1072
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1073
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1074
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1075
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1076
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
1077
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
1078
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
1079
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
1080
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1081
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1082
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
1083
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
1084
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
1085
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
1086
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1087
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1088
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1089
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1090
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
1091
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
1092
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
1093
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
1094
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
1095
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
1096
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
1097
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
1098
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
1099
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
1100
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
1101
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
1102
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
1103
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
1104
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
1105
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
1106
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
1107
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
1108
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
1109
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
1110
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
1111
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
1112
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
1113
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
1114
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
1115
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
1116
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
1117
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
1118
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
1119
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
1120
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1121
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1122
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1123
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1124
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1125
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1126
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1127
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1128
|
+
**source_links_in_count_min** | **Integer**| 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]
|
1129
|
+
**source_links_in_count_max** | **Integer**| 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]
|
1130
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
1131
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
1132
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
1133
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
1134
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
1135
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
1136
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
1137
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
1138
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
1139
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1140
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1141
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
662
1142
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
663
|
-
**sort_by** | **String**| This parameter is used for changing the order column of the results. | [optional] [default to published_at]
|
664
|
-
**sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc]
|
665
|
-
**cursor** | **String**| This parameter is used for finding a specific page. | [optional] [default to
|
666
|
-
**per_page** | **Integer**| This parameter is used for specifying number of items in each page.
|
1143
|
+
**sort_by** | **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']
|
1144
|
+
**sort_direction** | **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']
|
1145
|
+
**cursor** | **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 '*']
|
1146
|
+
**per_page** | **Integer**| 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]
|
667
1147
|
|
668
1148
|
### Return type
|
669
1149
|
|
@@ -671,80 +1151,129 @@ Name | Type | Description | Notes
|
|
671
1151
|
|
672
1152
|
### Authorization
|
673
1153
|
|
674
|
-
[
|
1154
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
675
1155
|
|
676
1156
|
### HTTP request headers
|
677
1157
|
|
678
|
-
|
679
|
-
|
1158
|
+
- **Content-Type**: Not defined
|
1159
|
+
- **Accept**: application/json, text/xml
|
680
1160
|
|
681
1161
|
|
1162
|
+
## list_time_series
|
682
1163
|
|
683
|
-
# **list_time_series**
|
684
1164
|
> TimeSeriesList list_time_series(opts)
|
685
1165
|
|
686
1166
|
List time series
|
687
1167
|
|
688
|
-
|
1168
|
+
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](https://newsapi.aylien.com/docs/working-with-dates), 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.
|
689
1169
|
|
690
1170
|
### Example
|
1171
|
+
|
691
1172
|
```ruby
|
692
1173
|
# load the gem
|
693
1174
|
require 'aylien_news_api'
|
694
|
-
|
695
1175
|
# setup authorization
|
696
1176
|
AylienNewsApi.configure do |config|
|
697
1177
|
# Configure API key authorization: app_id
|
698
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
1178
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
1179
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1180
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
699
1181
|
|
700
1182
|
# Configure API key authorization: app_key
|
701
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
1183
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
1184
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1185
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
702
1186
|
end
|
703
1187
|
|
704
1188
|
api_instance = AylienNewsApi::DefaultApi.new
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
title:
|
709
|
-
body:
|
710
|
-
text:
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
1189
|
+
opts = {
|
1190
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
1191
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
1192
|
+
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).
|
1193
|
+
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).
|
1194
|
+
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).
|
1195
|
+
translations_en_title: 'translations_en_title_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).
|
1196
|
+
translations_en_body: 'translations_en_body_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).
|
1197
|
+
translations_en_text: 'translations_en_text_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).
|
1198
|
+
language: ['language_example'], # Array<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.
|
1199
|
+
not_language: ['language_example'], # Array<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.
|
1200
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
1201
|
+
categories_confident: true, # Boolean | 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).
|
1202
|
+
categories_id: ['categories_id_example'], # Array<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).
|
1203
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
1204
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1205
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1206
|
+
categories_level: [56], # Array<Integer> | 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).
|
1207
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
1208
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
1209
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
1210
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
1211
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
1212
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
1213
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
1214
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
1215
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
1216
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
1217
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
1218
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
1219
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
1220
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1221
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1222
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
1223
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
1224
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
1225
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
1226
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
1227
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
1228
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
1229
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
1230
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
1231
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
1232
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
1233
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
1234
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
1235
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
1236
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
1237
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
1238
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
1239
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
1240
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
1241
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
1242
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
1243
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
1244
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
1245
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
1246
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
1247
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
1248
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
1249
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
1250
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
1251
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
1252
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1253
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1254
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1255
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1256
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1257
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1258
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1259
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1260
|
+
source_links_in_count_min: 56, # Integer | 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).
|
1261
|
+
source_links_in_count_max: 56, # Integer | 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).
|
1262
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
1263
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
1264
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
1265
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
1266
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
1267
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
1268
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
1269
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
1270
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
1271
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1272
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1273
|
+
clusters: ['clusters_example'], # Array<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).
|
1274
|
+
published_at_start: 'NOW-7DAYS/DAY', # 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).
|
1275
|
+
published_at_end: 'NOW/DAY', # 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).
|
1276
|
+
period: '+1DAY' # 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).
|
748
1277
|
}
|
749
1278
|
|
750
1279
|
begin
|
@@ -758,49 +1287,96 @@ end
|
|
758
1287
|
|
759
1288
|
### Parameters
|
760
1289
|
|
1290
|
+
|
761
1291
|
Name | Type | Description | Notes
|
762
1292
|
------------- | ------------- | ------------- | -------------
|
763
|
-
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding
|
764
|
-
**
|
765
|
-
**
|
766
|
-
**
|
767
|
-
**
|
768
|
-
**
|
769
|
-
**
|
770
|
-
**
|
771
|
-
**
|
772
|
-
**
|
773
|
-
**
|
774
|
-
**
|
775
|
-
**
|
776
|
-
**
|
777
|
-
**
|
778
|
-
**
|
779
|
-
**
|
780
|
-
**
|
781
|
-
**
|
782
|
-
**
|
783
|
-
**
|
784
|
-
**
|
785
|
-
**
|
786
|
-
**
|
787
|
-
**
|
788
|
-
**
|
789
|
-
**
|
790
|
-
**
|
791
|
-
**
|
792
|
-
**
|
793
|
-
**
|
794
|
-
**
|
795
|
-
**
|
796
|
-
**
|
797
|
-
**
|
798
|
-
**
|
799
|
-
**
|
800
|
-
**
|
801
|
-
**
|
802
|
-
**
|
803
|
-
**
|
1293
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
1294
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
1295
|
+
**title** | **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]
|
1296
|
+
**body** | **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]
|
1297
|
+
**text** | **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]
|
1298
|
+
**translations_en_title** | **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]
|
1299
|
+
**translations_en_body** | **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]
|
1300
|
+
**translations_en_text** | **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]
|
1301
|
+
**language** | [**Array<String>**](String.md)| 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]
|
1302
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
1303
|
+
**categories_taxonomy** | **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]
|
1304
|
+
**categories_confident** | **Boolean**| 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]
|
1305
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
1306
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
1307
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1308
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1309
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1310
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1311
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
1312
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
1313
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
1314
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
1315
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1316
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1317
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
1318
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
1319
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
1320
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
1321
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1322
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1323
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1324
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1325
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
1326
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
1327
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
1328
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
1329
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
1330
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
1331
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
1332
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
1333
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
1334
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
1335
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
1336
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
1337
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
1338
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
1339
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
1340
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
1341
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
1342
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
1343
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
1344
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
1345
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
1346
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
1347
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
1348
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
1349
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
1350
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
1351
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
1352
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
1353
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
1354
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
1355
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1356
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1357
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1358
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1359
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1360
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1361
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1362
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1363
|
+
**source_links_in_count_min** | **Integer**| 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]
|
1364
|
+
**source_links_in_count_max** | **Integer**| 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]
|
1365
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
1366
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
1367
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
1368
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
1369
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
1370
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
1371
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
1372
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
1373
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
1374
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1375
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1376
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
1377
|
+
**published_at_start** | **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']
|
1378
|
+
**published_at_end** | **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']
|
1379
|
+
**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](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to '+1DAY']
|
804
1380
|
|
805
1381
|
### Return type
|
806
1382
|
|
@@ -808,85 +1384,136 @@ Name | Type | Description | Notes
|
|
808
1384
|
|
809
1385
|
### Authorization
|
810
1386
|
|
811
|
-
[
|
1387
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
812
1388
|
|
813
1389
|
### HTTP request headers
|
814
1390
|
|
815
|
-
|
816
|
-
|
1391
|
+
- **Content-Type**: Not defined
|
1392
|
+
- **Accept**: application/json, text/xml
|
817
1393
|
|
818
1394
|
|
1395
|
+
## list_trends
|
819
1396
|
|
820
|
-
|
821
|
-
> Trends list_trends(opts)
|
1397
|
+
> Trends list_trends(field, opts)
|
822
1398
|
|
823
1399
|
List trends
|
824
1400
|
|
825
|
-
|
1401
|
+
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.
|
826
1402
|
|
827
1403
|
### Example
|
1404
|
+
|
828
1405
|
```ruby
|
829
1406
|
# load the gem
|
830
1407
|
require 'aylien_news_api'
|
831
|
-
|
832
1408
|
# setup authorization
|
833
1409
|
AylienNewsApi.configure do |config|
|
834
1410
|
# Configure API key authorization: app_id
|
835
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR
|
1411
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
1412
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1413
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
836
1414
|
|
837
1415
|
# Configure API key authorization: app_key
|
838
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR
|
1416
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
1417
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1418
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
839
1419
|
end
|
840
1420
|
|
841
1421
|
api_instance = AylienNewsApi::DefaultApi.new
|
842
|
-
|
843
|
-
opts = {
|
844
|
-
id: [56], # Array<Integer> | This parameter is used for finding
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
1422
|
+
field = 'keywords' # String | This parameter is used to specify the trend field.
|
1423
|
+
opts = {
|
1424
|
+
id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
|
1425
|
+
not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
|
1426
|
+
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).
|
1427
|
+
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).
|
1428
|
+
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).
|
1429
|
+
translations_en_title: 'translations_en_title_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).
|
1430
|
+
translations_en_body: 'translations_en_body_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).
|
1431
|
+
translations_en_text: 'translations_en_text_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).
|
1432
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
1433
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
1434
|
+
language: ['language_example'], # Array<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.
|
1435
|
+
not_language: ['language_example'], # Array<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.
|
1436
|
+
published_at_start: 'published_at_start_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).
|
1437
|
+
published_at_end: 'published_at_end_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).
|
1438
|
+
categories_taxonomy: 'categories_taxonomy_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).
|
1439
|
+
categories_confident: true, # Boolean | 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).
|
1440
|
+
categories_id: ['categories_id_example'], # Array<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).
|
1441
|
+
not_categories_id: ['categories_id_example'], # Array<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).
|
1442
|
+
categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1443
|
+
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1444
|
+
categories_level: [56], # Array<Integer> | 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).
|
1445
|
+
not_categories_level: [56], # Array<Integer> | 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).
|
1446
|
+
entities_title_text: ['entities_title_text_example'], # Array<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).
|
1447
|
+
not_entities_title_text: ['entities_title_text_example'], # Array<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).
|
1448
|
+
entities_title_type: ['entities_title_type_example'], # Array<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).
|
1449
|
+
not_entities_title_type: ['entities_title_type_example'], # Array<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).
|
1450
|
+
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
1451
|
+
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<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).
|
1452
|
+
entities_body_text: ['entities_body_text_example'], # Array<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).
|
1453
|
+
not_entities_body_text: ['entities_body_text_example'], # Array<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).
|
1454
|
+
entities_body_type: ['entities_body_type_example'], # Array<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).
|
1455
|
+
not_entities_body_type: ['entities_body_type_example'], # Array<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).
|
1456
|
+
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
1457
|
+
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<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).
|
1458
|
+
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1459
|
+
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1460
|
+
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
1461
|
+
not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
|
1462
|
+
media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
|
1463
|
+
media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
|
1464
|
+
media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
|
1465
|
+
media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
|
1466
|
+
media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
|
1467
|
+
media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
|
1468
|
+
media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
|
1469
|
+
media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
|
1470
|
+
media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
|
1471
|
+
not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
|
1472
|
+
media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
|
1473
|
+
media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
|
1474
|
+
author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
|
1475
|
+
not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
|
1476
|
+
author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
|
1477
|
+
not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
|
1478
|
+
source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
|
1479
|
+
not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
|
1480
|
+
source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
|
1481
|
+
not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
|
1482
|
+
source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
|
1483
|
+
not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
|
1484
|
+
source_locations_country: ['source_locations_country_example'], # Array<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).
|
1485
|
+
not_source_locations_country: ['source_locations_country_example'], # Array<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).
|
1486
|
+
source_locations_state: ['source_locations_state_example'], # Array<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).
|
1487
|
+
not_source_locations_state: ['source_locations_state_example'], # Array<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).
|
1488
|
+
source_locations_city: ['source_locations_city_example'], # Array<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).
|
1489
|
+
not_source_locations_city: ['source_locations_city_example'], # Array<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).
|
1490
|
+
source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1491
|
+
not_source_scopes_country: ['source_scopes_country_example'], # Array<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).
|
1492
|
+
source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1493
|
+
not_source_scopes_state: ['source_scopes_state_example'], # Array<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).
|
1494
|
+
source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1495
|
+
not_source_scopes_city: ['source_scopes_city_example'], # Array<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).
|
1496
|
+
source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1497
|
+
not_source_scopes_level: ['source_scopes_level_example'], # Array<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).
|
1498
|
+
source_links_in_count_min: 56, # Integer | 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).
|
1499
|
+
source_links_in_count_max: 56, # Integer | 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).
|
1500
|
+
source_rankings_alexa_rank_min: 56, # Integer | 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).
|
1501
|
+
source_rankings_alexa_rank_max: 56, # Integer | 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).
|
1502
|
+
source_rankings_alexa_country: ['source_rankings_alexa_country_example'], # Array<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).
|
1503
|
+
social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
|
1504
|
+
social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
|
1505
|
+
social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
|
1506
|
+
social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
|
1507
|
+
social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
|
1508
|
+
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
1509
|
+
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1510
|
+
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1511
|
+
clusters: ['clusters_example'] # Array<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).
|
885
1512
|
}
|
886
1513
|
|
887
1514
|
begin
|
888
1515
|
#List trends
|
889
|
-
result = api_instance.list_trends(opts)
|
1516
|
+
result = api_instance.list_trends(field, opts)
|
890
1517
|
p result
|
891
1518
|
rescue AylienNewsApi::ApiError => e
|
892
1519
|
puts "Exception when calling DefaultApi->list_trends: #{e}"
|
@@ -895,49 +1522,98 @@ end
|
|
895
1522
|
|
896
1523
|
### Parameters
|
897
1524
|
|
1525
|
+
|
898
1526
|
Name | Type | Description | Notes
|
899
1527
|
------------- | ------------- | ------------- | -------------
|
900
|
-
**
|
901
|
-
**
|
902
|
-
**
|
903
|
-
**
|
904
|
-
**
|
905
|
-
**
|
906
|
-
**
|
907
|
-
**
|
908
|
-
**
|
909
|
-
**
|
910
|
-
**
|
911
|
-
**
|
912
|
-
**
|
913
|
-
**
|
914
|
-
**
|
915
|
-
**
|
916
|
-
**
|
917
|
-
**
|
918
|
-
**
|
919
|
-
**
|
920
|
-
**
|
921
|
-
**
|
922
|
-
**
|
923
|
-
**
|
924
|
-
**
|
925
|
-
**
|
926
|
-
**
|
927
|
-
**
|
928
|
-
**
|
929
|
-
**
|
930
|
-
**
|
931
|
-
**
|
932
|
-
**
|
933
|
-
**
|
934
|
-
**
|
935
|
-
**
|
936
|
-
**
|
937
|
-
**
|
938
|
-
**
|
939
|
-
**
|
940
|
-
**
|
1528
|
+
**field** | **String**| This parameter is used to specify the trend field. |
|
1529
|
+
**id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
|
1530
|
+
**not_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
|
1531
|
+
**title** | **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]
|
1532
|
+
**body** | **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]
|
1533
|
+
**text** | **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]
|
1534
|
+
**translations_en_title** | **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]
|
1535
|
+
**translations_en_body** | **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]
|
1536
|
+
**translations_en_text** | **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]
|
1537
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
1538
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
1539
|
+
**language** | [**Array<String>**](String.md)| 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]
|
1540
|
+
**not_language** | [**Array<String>**](String.md)| 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]
|
1541
|
+
**published_at_start** | **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]
|
1542
|
+
**published_at_end** | **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]
|
1543
|
+
**categories_taxonomy** | **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]
|
1544
|
+
**categories_confident** | **Boolean**| 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]
|
1545
|
+
**categories_id** | [**Array<String>**](String.md)| 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]
|
1546
|
+
**not_categories_id** | [**Array<String>**](String.md)| 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]
|
1547
|
+
**categories_label** | [**Array<String>**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1548
|
+
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1549
|
+
**categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1550
|
+
**not_categories_level** | [**Array<Integer>**](Integer.md)| 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]
|
1551
|
+
**entities_title_text** | [**Array<String>**](String.md)| 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]
|
1552
|
+
**not_entities_title_text** | [**Array<String>**](String.md)| 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]
|
1553
|
+
**entities_title_type** | [**Array<String>**](String.md)| 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]
|
1554
|
+
**not_entities_title_type** | [**Array<String>**](String.md)| 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]
|
1555
|
+
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1556
|
+
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1557
|
+
**entities_body_text** | [**Array<String>**](String.md)| 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]
|
1558
|
+
**not_entities_body_text** | [**Array<String>**](String.md)| 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]
|
1559
|
+
**entities_body_type** | [**Array<String>**](String.md)| 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]
|
1560
|
+
**not_entities_body_type** | [**Array<String>**](String.md)| 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]
|
1561
|
+
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1562
|
+
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| 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]
|
1563
|
+
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1564
|
+
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1565
|
+
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
1566
|
+
**not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
|
1567
|
+
**media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
|
1568
|
+
**media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
|
1569
|
+
**media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
|
1570
|
+
**media_images_width_max** | **Integer**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
|
1571
|
+
**media_images_height_min** | **Integer**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
|
1572
|
+
**media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
|
1573
|
+
**media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
|
1574
|
+
**media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
|
1575
|
+
**media_images_format** | [**Array<String>**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
|
1576
|
+
**not_media_images_format** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
|
1577
|
+
**media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
|
1578
|
+
**media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
|
1579
|
+
**author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
|
1580
|
+
**not_author_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
|
1581
|
+
**author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
|
1582
|
+
**not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
|
1583
|
+
**source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
|
1584
|
+
**not_source_id** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
|
1585
|
+
**source_name** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
|
1586
|
+
**not_source_name** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
|
1587
|
+
**source_domain** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
|
1588
|
+
**not_source_domain** | [**Array<String>**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
|
1589
|
+
**source_locations_country** | [**Array<String>**](String.md)| 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]
|
1590
|
+
**not_source_locations_country** | [**Array<String>**](String.md)| 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]
|
1591
|
+
**source_locations_state** | [**Array<String>**](String.md)| 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]
|
1592
|
+
**not_source_locations_state** | [**Array<String>**](String.md)| 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]
|
1593
|
+
**source_locations_city** | [**Array<String>**](String.md)| 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]
|
1594
|
+
**not_source_locations_city** | [**Array<String>**](String.md)| 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]
|
1595
|
+
**source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1596
|
+
**not_source_scopes_country** | [**Array<String>**](String.md)| 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]
|
1597
|
+
**source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1598
|
+
**not_source_scopes_state** | [**Array<String>**](String.md)| 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]
|
1599
|
+
**source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1600
|
+
**not_source_scopes_city** | [**Array<String>**](String.md)| 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]
|
1601
|
+
**source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1602
|
+
**not_source_scopes_level** | [**Array<String>**](String.md)| 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]
|
1603
|
+
**source_links_in_count_min** | **Integer**| 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]
|
1604
|
+
**source_links_in_count_max** | **Integer**| 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]
|
1605
|
+
**source_rankings_alexa_rank_min** | **Integer**| 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]
|
1606
|
+
**source_rankings_alexa_rank_max** | **Integer**| 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]
|
1607
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| 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]
|
1608
|
+
**social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
|
1609
|
+
**social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
|
1610
|
+
**social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
|
1611
|
+
**social_shares_count_google_plus_max** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
|
1612
|
+
**social_shares_count_linkedin_min** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
|
1613
|
+
**social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
|
1614
|
+
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1615
|
+
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1616
|
+
**clusters** | [**Array<String>**](String.md)| 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]
|
941
1617
|
|
942
1618
|
### Return type
|
943
1619
|
|
@@ -945,12 +1621,10 @@ Name | Type | Description | Notes
|
|
945
1621
|
|
946
1622
|
### Authorization
|
947
1623
|
|
948
|
-
[
|
1624
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
949
1625
|
|
950
1626
|
### HTTP request headers
|
951
1627
|
|
952
|
-
|
953
|
-
|
954
|
-
|
955
|
-
|
1628
|
+
- **Content-Type**: Not defined
|
1629
|
+
- **Accept**: application/json, text/xml
|
956
1630
|
|