aylien_news_api 1.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +6 -0
  3. data/README.md +117 -4
  4. data/Rakefile +2 -0
  5. data/aylien_news_api.gemspec +16 -27
  6. data/docs/Author.md +12 -1
  7. data/docs/Autocomplete.md +10 -0
  8. data/docs/Autocompletes.md +9 -0
  9. data/docs/Category.md +17 -3
  10. data/docs/CategoryLinks.md +11 -1
  11. data/docs/Cluster.md +29 -0
  12. data/docs/Clusters.md +21 -0
  13. data/docs/Coverages.md +16 -4
  14. data/docs/DefaultApi.md +1250 -1117
  15. data/docs/Entities.md +11 -1
  16. data/docs/Entity.md +16 -3
  17. data/docs/EntityLinks.md +9 -0
  18. data/docs/Error.md +16 -2
  19. data/docs/ErrorLinks.md +9 -0
  20. data/docs/Errors.md +9 -0
  21. data/docs/HistogramInterval.md +10 -0
  22. data/docs/Histograms.md +16 -3
  23. data/docs/Location.md +13 -2
  24. data/docs/Media.md +17 -3
  25. data/docs/Rank.md +12 -1
  26. data/docs/Rankings.md +9 -0
  27. data/docs/RelatedStories.md +14 -3
  28. data/docs/RepresentativeStory.md +23 -0
  29. data/docs/Scope.md +14 -2
  30. data/docs/Sentiment.md +10 -0
  31. data/docs/Sentiments.md +12 -2
  32. data/docs/ShareCount.md +10 -0
  33. data/docs/ShareCounts.md +12 -0
  34. data/docs/Source.md +27 -8
  35. data/docs/Stories.md +11 -2
  36. data/docs/Story.md +48 -16
  37. data/docs/StoryCluster.md +14 -1
  38. data/docs/StoryLinks.md +14 -2
  39. data/docs/StoryTranslations.md +17 -0
  40. data/docs/StoryTranslationsEn.md +21 -0
  41. data/docs/Summary.md +9 -0
  42. data/docs/TimeSeries.md +11 -1
  43. data/docs/TimeSeriesList.md +15 -3
  44. data/docs/Trend.md +11 -1
  45. data/docs/Trends.md +11 -1
  46. data/git_push.sh +58 -0
  47. data/lib/aylien_news_api.rb +11 -10
  48. data/lib/aylien_news_api/api/default_api.rb +2065 -1801
  49. data/lib/aylien_news_api/api_client.rb +129 -108
  50. data/lib/aylien_news_api/api_error.rb +25 -10
  51. data/lib/aylien_news_api/configuration.rb +69 -33
  52. data/lib/aylien_news_api/models/author.rb +50 -46
  53. data/lib/aylien_news_api/models/autocomplete.rb +36 -32
  54. data/lib/aylien_news_api/models/autocompletes.rb +35 -31
  55. data/lib/aylien_news_api/models/category.rb +63 -59
  56. data/lib/aylien_news_api/models/category_links.rb +47 -43
  57. data/lib/aylien_news_api/models/cluster.rb +255 -0
  58. data/lib/aylien_news_api/models/clusters.rb +219 -0
  59. data/lib/aylien_news_api/models/coverages.rb +60 -68
  60. data/lib/aylien_news_api/models/entities.rb +48 -44
  61. data/lib/aylien_news_api/models/entity.rb +71 -69
  62. data/lib/aylien_news_api/models/entity_links.rb +35 -31
  63. data/lib/aylien_news_api/models/error.rb +60 -56
  64. data/lib/aylien_news_api/models/error_links.rb +35 -31
  65. data/lib/aylien_news_api/models/errors.rb +35 -31
  66. data/lib/aylien_news_api/models/histogram_interval.rb +36 -32
  67. data/lib/aylien_news_api/models/histograms.rb +62 -58
  68. data/lib/aylien_news_api/models/location.rb +51 -47
  69. data/lib/aylien_news_api/models/media.rb +81 -76
  70. data/lib/aylien_news_api/models/rank.rb +48 -44
  71. data/lib/aylien_news_api/models/rankings.rb +35 -31
  72. data/lib/aylien_news_api/models/related_stories.rb +53 -61
  73. data/lib/aylien_news_api/models/representative_story.rb +227 -0
  74. data/lib/aylien_news_api/models/scope.rb +59 -54
  75. data/lib/aylien_news_api/models/sentiment.rb +41 -37
  76. data/lib/aylien_news_api/models/sentiments.rb +46 -44
  77. data/lib/aylien_news_api/models/share_count.rb +36 -32
  78. data/lib/aylien_news_api/models/share_counts.rb +38 -34
  79. data/lib/aylien_news_api/models/source.rb +95 -92
  80. data/lib/aylien_news_api/models/stories.rb +47 -55
  81. data/lib/aylien_news_api/models/story.rb +172 -154
  82. data/lib/aylien_news_api/models/story_cluster.rb +52 -48
  83. data/lib/aylien_news_api/models/story_links.rb +58 -54
  84. data/lib/aylien_news_api/models/story_translations.rb +197 -0
  85. data/lib/aylien_news_api/models/story_translations_en.rb +217 -0
  86. data/lib/aylien_news_api/models/summary.rb +35 -31
  87. data/lib/aylien_news_api/models/time_series.rb +47 -43
  88. data/lib/aylien_news_api/models/time_series_list.rb +56 -52
  89. data/lib/aylien_news_api/models/trend.rb +47 -43
  90. data/lib/aylien_news_api/models/trends.rb +48 -44
  91. data/lib/aylien_news_api/version.rb +7 -11
  92. data/spec/api/default_api_spec.rb +569 -533
  93. data/spec/api_client_spec.rb +34 -76
  94. data/spec/configuration_spec.rb +14 -18
  95. data/spec/models/author_spec.rb +15 -18
  96. data/spec/models/autocomplete_spec.rb +11 -14
  97. data/spec/models/autocompletes_spec.rb +10 -13
  98. data/spec/models/category_links_spec.rb +13 -16
  99. data/spec/models/category_spec.rb +24 -27
  100. data/spec/models/cluster_spec.rb +77 -0
  101. data/spec/models/clusters_spec.rb +53 -0
  102. data/spec/models/coverages_spec.rb +17 -26
  103. data/spec/models/entities_spec.rb +13 -16
  104. data/spec/models/entity_links_spec.rb +10 -13
  105. data/spec/models/entity_spec.rb +19 -22
  106. data/spec/models/error_links_spec.rb +10 -13
  107. data/spec/models/error_spec.rb +21 -24
  108. data/spec/models/errors_spec.rb +10 -13
  109. data/spec/models/histogram_interval_spec.rb +11 -14
  110. data/spec/models/histograms_spec.rb +18 -21
  111. data/spec/models/location_spec.rb +15 -18
  112. data/spec/models/media_spec.rb +29 -32
  113. data/spec/models/rank_spec.rb +15 -18
  114. data/spec/models/rankings_spec.rb +10 -13
  115. data/spec/models/related_stories_spec.rb +15 -24
  116. data/spec/models/representative_story_spec.rb +59 -0
  117. data/spec/models/scope_spec.rb +21 -24
  118. data/spec/models/sentiment_spec.rb +15 -18
  119. data/spec/models/sentiments_spec.rb +13 -16
  120. data/spec/models/share_count_spec.rb +11 -14
  121. data/spec/models/share_counts_spec.rb +13 -16
  122. data/spec/models/source_spec.rb +29 -32
  123. data/spec/models/stories_spec.rb +13 -22
  124. data/spec/models/story_cluster_spec.rb +17 -20
  125. data/spec/models/story_links_spec.rb +17 -20
  126. data/spec/models/story_spec.rb +59 -50
  127. data/spec/models/story_translations_en_spec.rb +53 -0
  128. data/spec/models/story_translations_spec.rb +41 -0
  129. data/spec/models/summary_spec.rb +10 -13
  130. data/spec/models/time_series_list_spec.rb +16 -19
  131. data/spec/models/time_series_spec.rb +13 -16
  132. data/spec/models/trend_spec.rb +13 -16
  133. data/spec/models/trends_spec.rb +13 -16
  134. data/spec/spec_helper.rb +6 -10
  135. metadata +68 -194
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 5ea05755c0dca9f54d2692d19de7c0b3e57b56f5
4
- data.tar.gz: c01243a6380de1279f16e05cb40732e78b577bec
2
+ SHA256:
3
+ metadata.gz: b86de43ffb6dfbd47a63091e4f8409a0a38ba03ff3cdb3f7723115f32807924d
4
+ data.tar.gz: ffd457acccc7b01063d84c1856f813e391354edff0035dd15e9fff3ec3f227ab
5
5
  SHA512:
6
- metadata.gz: e88fd64f146b7d7b04dbf79163f7b89ba4beea6de80658a779b51a5ff19a33a2b6e7a10548741551372ba76c5e7ab174ae7d847b958381ee6bb33a8ccff67fc8
7
- data.tar.gz: c0ab73ef74b8e631a837fbddaa2eda33e57e23044d9857bedb21886d6efbeee407dcf419768a0d500363725f2502df83dea4522415d3e95012da1fee0487a0eb
6
+ metadata.gz: 90a3735c95c3368bf6f91d884eacd662cb15fc378fb56d1edd6394d02ac1a4149b89e1c34ce91ec03ec3a451d805b27833ff0a67744756aaccdc2eb38c0da6c6
7
+ data.tar.gz: 5f6172eb9086d78731d7d58830d6ce48a84c7be42b4d082f75f0b524ac17207adb0f258f45220a1501646b649ddc8d29e611705ee55189c1958ae76208bc875b
data/Gemfile CHANGED
@@ -1,3 +1,9 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
3
  gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/README.md CHANGED
@@ -1,10 +1,123 @@
1
- # AYLIEN News API
1
+ # AYLIEN News API - Ruby SDK
2
2
 
3
- AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content.
3
+ The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
4
4
 
5
5
  Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
6
6
 
7
7
  For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
8
8
 
9
- ## Bug Reports
10
- If you've got a bug report, please contact us at support@aylien.com.
9
+ ## Installation
10
+
11
+ Add this to the Gemfile:
12
+
13
+ gem 'aylien_news_api', '~> 3.0.0'
14
+
15
+ ### Install from Git
16
+
17
+ If the Ruby gem is hosted at a git repository: https://github.com/aylien/aylien_newsapi_ruby, then add the following in the Gemfile:
18
+
19
+ gem 'aylien_news_api', :git => 'https://github.com/aylien/aylien_newsapi_ruby.git'
20
+
21
+ ### Include the Ruby code directly
22
+
23
+ Include the Ruby code directly using `-I` as follows:
24
+
25
+ ```shell
26
+ ruby -Ilib script.rb
27
+ ```
28
+
29
+ ## Getting Started
30
+
31
+ Please follow the [installation](#installation) procedure and then run the following code:
32
+ ```ruby
33
+ # Load the gem
34
+ require 'aylien_news_api'
35
+
36
+ # Setup authorization
37
+ AylienNewsApi.configure do |config|
38
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = ENV['NEWSAPI_APP_ID']
39
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = ENV['NEWSAPI_APP_KEY']
40
+ end
41
+
42
+ api_instance = AylienNewsApi::DefaultApi.new
43
+
44
+ opts = {
45
+ title: 'trump',
46
+ published_at_start: "NOW-7DAYS",
47
+ published_at_end: "NOW",
48
+ entities_body_links_dbpedia: [
49
+ 'http://dbpedia.org/resource/Donald_Trump',
50
+ ],
51
+ not_language: ['en'],
52
+ sort_by: 'social_shares_count.facebook'
53
+ }
54
+
55
+
56
+ begin
57
+ result = api_instance.list_stories(opts)
58
+ result.stories.each do |story|
59
+ puts "#{story.title} / #{story.source.name}"
60
+ end
61
+ rescue AylienNewsApi::ApiError => e
62
+ puts "Exception when calling DefaultApi->list_stories: #{e}"
63
+ puts e.response_body
64
+ end
65
+ ```
66
+
67
+ ## Documentation for API Endpoints
68
+
69
+ All URIs are relative to *https://api.aylien.com/news*
70
+
71
+ Class | Method | HTTP request | Description
72
+ ------------ | ------------- | ------------- | -------------
73
+ *AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
74
+ *AylienNewsApi::DefaultApi* | [**list_clusters**](docs/DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
75
+ *AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
76
+ *AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
77
+ *AylienNewsApi::DefaultApi* | [**list_related_stories**](docs/DefaultApi.md#list_related_stories) | **GET** /related_stories | List related stories
78
+ *AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
79
+ *AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
80
+ *AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
81
+
82
+
83
+ ## Documentation for Models
84
+
85
+ - [AylienNewsApi::Author](docs/Author.md)
86
+ - [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
87
+ - [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
88
+ - [AylienNewsApi::Category](docs/Category.md)
89
+ - [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
90
+ - [AylienNewsApi::Cluster](docs/Cluster.md)
91
+ - [AylienNewsApi::Clusters](docs/Clusters.md)
92
+ - [AylienNewsApi::Coverages](docs/Coverages.md)
93
+ - [AylienNewsApi::Entities](docs/Entities.md)
94
+ - [AylienNewsApi::Entity](docs/Entity.md)
95
+ - [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
96
+ - [AylienNewsApi::Error](docs/Error.md)
97
+ - [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
98
+ - [AylienNewsApi::Errors](docs/Errors.md)
99
+ - [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
100
+ - [AylienNewsApi::Histograms](docs/Histograms.md)
101
+ - [AylienNewsApi::Location](docs/Location.md)
102
+ - [AylienNewsApi::Media](docs/Media.md)
103
+ - [AylienNewsApi::Rank](docs/Rank.md)
104
+ - [AylienNewsApi::Rankings](docs/Rankings.md)
105
+ - [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
106
+ - [AylienNewsApi::RepresentativeStory](docs/RepresentativeStory.md)
107
+ - [AylienNewsApi::Scope](docs/Scope.md)
108
+ - [AylienNewsApi::Sentiment](docs/Sentiment.md)
109
+ - [AylienNewsApi::Sentiments](docs/Sentiments.md)
110
+ - [AylienNewsApi::ShareCount](docs/ShareCount.md)
111
+ - [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
112
+ - [AylienNewsApi::Source](docs/Source.md)
113
+ - [AylienNewsApi::Stories](docs/Stories.md)
114
+ - [AylienNewsApi::Story](docs/Story.md)
115
+ - [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
116
+ - [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
117
+ - [AylienNewsApi::StoryTranslations](docs/StoryTranslations.md)
118
+ - [AylienNewsApi::StoryTranslationsEn](docs/StoryTranslationsEn.md)
119
+ - [AylienNewsApi::Summary](docs/Summary.md)
120
+ - [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
121
+ - [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
122
+ - [AylienNewsApi::Trend](docs/Trend.md)
123
+ - [AylienNewsApi::Trends](docs/Trends.md)
data/Rakefile CHANGED
@@ -1,3 +1,5 @@
1
+ require "bundler/gem_tasks"
2
+
1
3
  begin
2
4
  require 'rspec/core/rake_task'
3
5
 
@@ -1,19 +1,15 @@
1
1
  # -*- encoding: utf-8 -*-
2
- #
2
+
3
3
  =begin
4
- Copyright 2017 Aylien, Inc. All Rights Reserved.
4
+ #AYLIEN News API
5
5
 
6
- Licensed under the Apache License, Version 2.0 (the "License");
7
- you may not use this file except in compliance with the License.
8
- You may obtain a copy of the License at
6
+ #The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
9
7
 
10
- http://www.apache.org/licenses/LICENSE-2.0
8
+ The version of the OpenAPI document: 3.0
9
+ Contact: support@aylien.com
10
+ Generated by: https://openapi-generator.tech
11
+ OpenAPI Generator version: 4.1.3-SNAPSHOT
11
12
 
12
- Unless required by applicable law or agreed to in writing, software
13
- distributed under the License is distributed on an "AS IS" BASIS,
14
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- See the License for the specific language governing permissions and
16
- limitations under the License.
17
13
  =end
18
14
 
19
15
  $:.push File.expand_path("../lib", __FILE__)
@@ -23,27 +19,20 @@ Gem::Specification.new do |s|
23
19
  s.name = "aylien_news_api"
24
20
  s.version = AylienNewsApi::VERSION
25
21
  s.platform = Gem::Platform::RUBY
26
- s.authors = ["Hamed Ramezanian Nik"]
27
- s.email = ["hamed.r.nik@gmail.com"]
22
+ s.authors = ["AYLIEN"]
23
+ s.email = ["info@aylien.com"]
28
24
  s.homepage = "https://newsapi.aylien.com/"
29
- s.summary = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content"
30
- s.description = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content."
31
- s.license = "Apache-2.0"
25
+ s.summary = "AYLIEN's officially supported Ruby client library for accessing News API"
26
+ s.description = "AYLIEN's officially supported Ruby client library for accessing News API"
27
+ s.license = 'Apache-2.0'
32
28
  s.required_ruby_version = ">= 1.9"
33
29
 
34
- s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
35
- s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
30
+ s.add_runtime_dependency 'faraday', '>= 0.14.0'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
36
32
 
37
- s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
38
- s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
39
- s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
40
- s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
41
- s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
42
- s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
43
- s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
44
- s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
45
34
 
46
- s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
35
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
47
36
  s.test_files = `find spec/*`.split("\n")
48
37
  s.executables = []
49
38
  s.require_paths = ["lib"]
@@ -1,10 +1,21 @@
1
1
  # AylienNewsApi::Author
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
7
+ **avatar_url** | **String** | A URL which points to the author avatar | [optional]
6
8
  **id** | **Integer** | A unique identification for the author | [optional]
7
9
  **name** | **String** | The extracted author full name | [optional]
8
- **avatar_url** | **String** | A URL which points to the author avatar | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'AylienNewsApi'
15
+
16
+ instance = AylienNewsApi::Author.new(avatar_url: null,
17
+ id: null,
18
+ name: null)
19
+ ```
9
20
 
10
21
 
@@ -1,9 +1,19 @@
1
1
  # AylienNewsApi::Autocomplete
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
7
  **id** | **String** | ID of the autocomplete | [optional]
7
8
  **text** | **String** | Text of the autocomplete | [optional]
8
9
 
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'AylienNewsApi'
14
+
15
+ instance = AylienNewsApi::Autocomplete.new(id: null,
16
+ text: null)
17
+ ```
18
+
9
19
 
@@ -1,8 +1,17 @@
1
1
  # AylienNewsApi::Autocompletes
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
7
  **autocompletes** | [**Array<Autocomplete>**](Autocomplete.md) | An array of autocompletes | [optional]
7
8
 
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'AylienNewsApi'
13
+
14
+ instance = AylienNewsApi::Autocompletes.new(autocompletes: null)
15
+ ```
16
+
8
17
 
@@ -1,13 +1,27 @@
1
1
  # AylienNewsApi::Category
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
7
+ **confident** | **Boolean** | It defines whether the extracted category is confident or not | [optional]
6
8
  **id** | **String** | The ID of the category | [optional]
7
- **taxonomy** | **String** | The taxonomy of the category | [optional]
8
9
  **level** | **Integer** | The level of the category | [optional]
10
+ **links** | [**CategoryLinks**](CategoryLinks.md) | | [optional]
9
11
  **score** | **Float** | The score of the category | [optional]
10
- **confident** | **BOOLEAN** | It defines whether the extracted category is confident or not | [optional]
11
- **links** | [**CategoryLinks**](CategoryLinks.md) | Related links for the category | [optional]
12
+ **taxonomy** | **String** | The taxonomy of the category | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'AylienNewsApi'
18
+
19
+ instance = AylienNewsApi::Category.new(confident: null,
20
+ id: null,
21
+ level: null,
22
+ links: null,
23
+ score: null,
24
+ taxonomy: null)
25
+ ```
12
26
 
13
27
 
@@ -1,9 +1,19 @@
1
1
  # AylienNewsApi::CategoryLinks
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
- **_self** | **String** | A URL pointing to the category | [optional]
7
7
  **parent** | **String** | A URL pointing to the parent category | [optional]
8
+ **_self** | **String** | A URL pointing to the category | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'AylienNewsApi'
14
+
15
+ instance = AylienNewsApi::CategoryLinks.new(parent: null,
16
+ _self: null)
17
+ ```
8
18
 
9
19
 
@@ -0,0 +1,29 @@
1
+ # AylienNewsApi::Cluster
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **earliest_story** | **DateTime** | Publication date of the earliest story in cluster | [optional]
8
+ **id** | **Integer** | ID of the cluster which is a unique identification | [optional]
9
+ **latest_story** | **DateTime** | Publication date of the latest story in cluster | [optional]
10
+ **location** | [**Location**](Location.md) | | [optional]
11
+ **representative_story** | [**RepresentativeStory**](RepresentativeStory.md) | | [optional]
12
+ **story_count** | **Integer** | Number of stories associated with the cluster | [optional]
13
+ **time** | **DateTime** | Time of the event | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'AylienNewsApi'
19
+
20
+ instance = AylienNewsApi::Cluster.new(earliest_story: null,
21
+ id: null,
22
+ latest_story: null,
23
+ location: null,
24
+ representative_story: null,
25
+ story_count: null,
26
+ time: null)
27
+ ```
28
+
29
+
@@ -0,0 +1,21 @@
1
+ # AylienNewsApi::Clusters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **cluster_count** | **Integer** | The total number of clusters | [optional]
8
+ **clusters** | [**Array<Cluster>**](Cluster.md) | An array of clusters | [optional]
9
+ **next_page_cursor** | **String** | The next page cursor | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'AylienNewsApi'
15
+
16
+ instance = AylienNewsApi::Clusters.new(cluster_count: null,
17
+ clusters: null,
18
+ next_page_cursor: null)
19
+ ```
20
+
21
+
@@ -1,13 +1,25 @@
1
1
  # AylienNewsApi::Coverages
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
- **story_title** | **String** | The input story title | [optional]
7
+ **coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional]
7
8
  **story_body** | **String** | The input story body | [optional]
8
- **story_published_at** | **DateTime** | The input story published date | [optional]
9
9
  **story_language** | **String** | The input story language | [optional]
10
- **coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional]
11
- **clusters** | [**Array<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional]
10
+ **story_published_at** | **DateTime** | The input story published date | [optional]
11
+ **story_title** | **String** | The input story title | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'AylienNewsApi'
17
+
18
+ instance = AylienNewsApi::Coverages.new(coverages: null,
19
+ story_body: null,
20
+ story_language: null,
21
+ story_published_at: null,
22
+ story_title: null)
23
+ ```
12
24
 
13
25
 
@@ -1,67 +1,72 @@
1
1
  # AylienNewsApi::DefaultApi
2
2
 
3
- All URIs are relative to *https://api.newsapi.aylien.com/api/v1*
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
- [**list_coverages**](DefaultApi.md#list_coverages) | **POST** /coverages | List coverages
8
+ [**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
9
+ [**list_coverages**](DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
9
10
  [**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
10
- [**list_related_stories**](DefaultApi.md#list_related_stories) | **POST** /related_stories | List related stories
11
+ [**list_related_stories**](DefaultApi.md#list_related_stories) | **GET** /related_stories | List 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
- # **list_autocompletes**
17
+
18
+ ## list_autocompletes
19
+
17
20
  > Autocompletes list_autocompletes(type, term, opts)
18
21
 
19
22
  List autocompletes
20
23
 
21
- This endpoint is used for getting list of autocompletes by providing a specific term and type.
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_APP_ID'
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_APP_KEY'
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
- type = "type_example"
40
- term = "term_example"
41
-
42
- opts = {
43
- language: "en",
44
- per_page: 3
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.
45
50
  }
46
51
 
47
52
  begin
48
53
  #List autocompletes
49
54
  result = api_instance.list_autocompletes(type, term, opts)
50
- puts result
55
+ p result
51
56
  rescue AylienNewsApi::ApiError => e
52
57
  puts "Exception when calling DefaultApi->list_autocompletes: #{e}"
53
- puts e.response_body
54
58
  end
55
59
  ```
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. | [enum: source_names, source_domains, entity_types, dbpedia_resources]
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. | [optional] [default to en] [enum: en, de, fr, it, es, pt]
64
- **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
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,235 +74,325 @@ Name | Type | Description | Notes
69
74
 
70
75
  ### Authorization
71
76
 
72
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
77
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
73
78
 
74
79
  ### HTTP request headers
75
80
 
76
- - **Content-Type**: application/x-www-form-urlencoded
77
- - **Accept**: application/json, text/xml
81
+ - **Content-Type**: Not defined
82
+ - **Accept**: application/json, text/xml
83
+
84
+
85
+ ## list_clusters
86
+
87
+ > Clusters list_clusters(opts)
78
88
 
89
+ List Clusters
79
90
 
91
+ The clusters endpoint is used to return clusters based on parameters you set in your query.
92
+
93
+ ### Example
94
+
95
+ ```ruby
96
+ # load the gem
97
+ require 'aylien_news_api'
98
+ # setup authorization
99
+ AylienNewsApi.configure do |config|
100
+ # Configure API key authorization: app_id
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'
104
+
105
+ # Configure API key authorization: app_key
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'
109
+ end
110
+
111
+ api_instance = AylienNewsApi::DefaultApi.new
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
+ }
126
+
127
+ begin
128
+ #List Clusters
129
+ result = api_instance.list_clusters(opts)
130
+ p result
131
+ rescue AylienNewsApi::ApiError => e
132
+ puts "Exception when calling DefaultApi->list_clusters: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+
139
+ Name | Type | Description | Notes
140
+ ------------- | ------------- | ------------- | -------------
141
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding clusters by cluster id. | [optional]
142
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding clusters by cluster id. | [optional]
143
+ **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]
144
+ **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]
145
+ **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]
146
+ **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]
147
+ **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]
148
+ **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]
149
+ **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]
150
+ **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]
151
+ **location_country** | [**Array&lt;String&gt;**](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]
152
+ **not_location_country** | [**Array&lt;String&gt;**](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]
153
+
154
+ ### Return type
155
+
156
+ [**Clusters**](Clusters.md)
157
+
158
+ ### Authorization
159
+
160
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: Not defined
165
+ - **Accept**: application/json, text/xml
166
+
167
+
168
+ ## list_coverages
80
169
 
81
- # **list_coverages**
82
170
  > Coverages list_coverages(opts)
83
171
 
84
172
  List coverages
85
173
 
86
- This endpoint is used for finding story coverages based on the parameters provided. The maximum number of related stories returned is 100.
174
+ The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.
87
175
 
88
176
  ### Example
177
+
89
178
  ```ruby
90
179
  # load the gem
91
180
  require 'aylien_news_api'
92
-
93
181
  # setup authorization
94
182
  AylienNewsApi.configure do |config|
95
183
  # Configure API key authorization: app_id
96
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
184
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
97
187
 
98
188
  # Configure API key authorization: app_key
99
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
189
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
190
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
191
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
100
192
  end
101
193
 
102
194
  api_instance = AylienNewsApi::DefaultApi.new
103
-
104
- opts = {
105
- id: [56],
106
- not_id: [56],
107
- title: "title_example",
108
- body: "body_example",
109
- text: "text_example",
110
- language: ["language_example"],
111
- not_language: ["not_language_example"],
112
- published_at_start: "published_at_start_example",
113
- published_at_end: "published_at_end_example",
114
- categories_taxonomy: "categories_taxonomy_example",
115
- categories_confident: true,
116
- categories_id: ["categories_id_example"],
117
- not_categories_id: ["not_categories_id_example"],
118
- categories_level: [56],
119
- not_categories_level: [56],
120
- entities_title_text: ["entities_title_text_example"],
121
- not_entities_title_text: ["not_entities_title_text_example"],
122
- entities_title_type: ["entities_title_type_example"],
123
- not_entities_title_type: ["not_entities_title_type_example"],
124
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
125
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
126
- entities_body_text: ["entities_body_text_example"],
127
- not_entities_body_text: ["not_entities_body_text_example"],
128
- entities_body_type: ["entities_body_type_example"],
129
- not_entities_body_type: ["not_entities_body_type_example"],
130
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
131
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
132
- sentiment_title_polarity: "sentiment_title_polarity_example",
133
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
134
- sentiment_body_polarity: "sentiment_body_polarity_example",
135
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
136
- media_images_count_min: 56,
137
- media_images_count_max: 56,
138
- media_images_width_min: 56,
139
- media_images_width_max: 56,
140
- media_images_height_min: 56,
141
- media_images_height_max: 56,
142
- media_images_content_length_min: 56,
143
- media_images_content_length_max: 56,
144
- media_images_format: ["media_images_format_example"],
145
- not_media_images_format: ["not_media_images_format_example"],
146
- media_videos_count_min: 56,
147
- media_videos_count_max: 56,
148
- author_id: [56],
149
- not_author_id: [56],
150
- author_name: "author_name_example",
151
- not_author_name: "not_author_name_example",
152
- source_id: [56],
153
- not_source_id: [56],
154
- source_name: ["source_name_example"],
155
- not_source_name: ["not_source_name_example"],
156
- source_domain: ["source_domain_example"],
157
- not_source_domain: ["not_source_domain_example"],
158
- source_locations_country: ["source_locations_country_example"],
159
- not_source_locations_country: ["not_source_locations_country_example"],
160
- source_locations_state: ["source_locations_state_example"],
161
- not_source_locations_state: ["not_source_locations_state_example"],
162
- source_locations_city: ["source_locations_city_example"],
163
- not_source_locations_city: ["not_source_locations_city_example"],
164
- source_scopes_country: ["source_scopes_country_example"],
165
- not_source_scopes_country: ["not_source_scopes_country_example"],
166
- source_scopes_state: ["source_scopes_state_example"],
167
- not_source_scopes_state: ["not_source_scopes_state_example"],
168
- source_scopes_city: ["source_scopes_city_example"],
169
- not_source_scopes_city: ["not_source_scopes_city_example"],
170
- source_scopes_level: ["source_scopes_level_example"],
171
- not_source_scopes_level: ["not_source_scopes_level_example"],
172
- source_links_in_count_min: 56,
173
- source_links_in_count_max: 56,
174
- source_rankings_alexa_rank_min: 56,
175
- source_rankings_alexa_rank_max: 56,
176
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
177
- social_shares_count_facebook_min: 56,
178
- social_shares_count_facebook_max: 56,
179
- social_shares_count_google_plus_min: 56,
180
- social_shares_count_google_plus_max: 56,
181
- social_shares_count_linkedin_min: 56,
182
- social_shares_count_linkedin_max: 56,
183
- social_shares_count_reddit_min: 56,
184
- social_shares_count_reddit_max: 56,
185
- cluster: false,
186
- cluster_algorithm: "lingo",
187
- _return: ["_return_example"],
188
- story_id: 789,
189
- story_url: "story_url_example",
190
- story_title: "story_title_example",
191
- story_body: "story_body_example",
192
- story_published_at: DateTime.parse("2013-10-20T19:20:30+01:00"),
193
- story_language: "auto",
194
- per_page: 3
195
+ opts = {
196
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
197
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
198
+ 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).
199
+ 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).
200
+ 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).
201
+ 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).
202
+ 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).
203
+ 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).
204
+ 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.
205
+ 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.
206
+ 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).
207
+ 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).
208
+ 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).
209
+ 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).
210
+ 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).
211
+ 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).
212
+ 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).
213
+ 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).
214
+ 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).
215
+ 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).
216
+ 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).
217
+ 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).
218
+ 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).
219
+ 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).
220
+ 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).
221
+ 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).
222
+ 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).
223
+ 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).
224
+ 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).
225
+ 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).
226
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
227
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
228
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
229
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
230
+ 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.
231
+ 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.
232
+ 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.
233
+ 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.
234
+ 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.
235
+ 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.
236
+ 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.
237
+ 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.
238
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
239
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
240
+ 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.
241
+ 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.
242
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
243
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
244
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
245
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
246
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
247
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
248
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
249
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
250
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
251
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
252
+ 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).
253
+ 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).
254
+ 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).
255
+ 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).
256
+ 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).
257
+ 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).
258
+ 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).
259
+ 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).
260
+ 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).
261
+ 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).
262
+ 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).
263
+ 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).
264
+ 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).
265
+ 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).
266
+ 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).
267
+ 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).
268
+ 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).
269
+ 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).
270
+ 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).
271
+ 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.
272
+ 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.
273
+ 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.
274
+ 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.
275
+ 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.
276
+ 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.
277
+ 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.
278
+ 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.
279
+ 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).
280
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
281
+ story_id: 56, # Integer | A story id
282
+ story_url: 'story_url_example', # String | An article or webpage
283
+ story_title: 'story_title_example', # String | Title of the article
284
+ story_body: 'story_body_example', # String | Body of the article
285
+ 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).
286
+ 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.
287
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
195
288
  }
196
289
 
197
290
  begin
198
291
  #List coverages
199
292
  result = api_instance.list_coverages(opts)
200
- puts result
293
+ p result
201
294
  rescue AylienNewsApi::ApiError => e
202
295
  puts "Exception when calling DefaultApi->list_coverages: #{e}"
203
- puts e.response_body
204
296
  end
205
297
  ```
206
298
 
207
299
  ### Parameters
208
300
 
301
+
209
302
  Name | Type | Description | Notes
210
303
  ------------- | ------------- | ------------- | -------------
211
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
212
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
213
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
214
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
215
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
216
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
217
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
218
- **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]
219
- **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]
220
- **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] [enum: iab-qag, iptc-subjectcode]
221
- **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]
222
- **categories_id** | **Array&lt;String&gt;**| 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]
223
- **not_categories_id** | **Array&lt;String&gt;**| 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]
224
- **categories_level** | **Array&lt;Integer&gt;**| 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]
225
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
226
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
227
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
228
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
229
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
230
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
231
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
232
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
233
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
234
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
235
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
236
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
237
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
238
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
239
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
240
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
241
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
242
- **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]
243
- **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]
244
- **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]
245
- **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]
246
- **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]
247
- **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]
248
- **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]
249
- **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]
250
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
251
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
252
- **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]
253
- **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]
254
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
255
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
256
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
257
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
258
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
259
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
260
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
261
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
262
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
263
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
264
- **source_locations_country** | **Array&lt;String&gt;**| 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]
265
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
266
- **source_locations_state** | **Array&lt;String&gt;**| 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]
267
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
268
- **source_locations_city** | **Array&lt;String&gt;**| 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]
269
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
270
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
271
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
272
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
273
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
274
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
275
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
276
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
277
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
278
- **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]
279
- **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]
280
- **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]
281
- **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]
282
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
283
- **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]
284
- **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]
285
- **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]
286
- **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]
287
- **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]
288
- **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]
289
- **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]
290
- **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]
291
- **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
292
- **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. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
293
- **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links]
304
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
305
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
306
+ **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]
307
+ **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]
308
+ **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]
309
+ **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]
310
+ **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]
311
+ **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]
312
+ **language** | [**Array&lt;String&gt;**](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]
313
+ **not_language** | [**Array&lt;String&gt;**](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]
314
+ **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]
315
+ **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]
316
+ **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]
317
+ **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]
318
+ **categories_id** | [**Array&lt;String&gt;**](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]
319
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
320
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
321
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
322
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
323
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
324
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
325
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
326
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
327
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
328
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
329
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
330
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
331
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
332
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
333
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
334
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
335
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
336
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
337
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
338
+ **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]
339
+ **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]
340
+ **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]
341
+ **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]
342
+ **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]
343
+ **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]
344
+ **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]
345
+ **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]
346
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
347
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
348
+ **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]
349
+ **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]
350
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
351
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
352
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
353
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
354
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
355
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
356
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
357
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
358
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
359
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
360
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
361
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
362
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
363
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
364
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
365
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
366
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
367
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
368
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
369
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
370
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
371
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
372
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
373
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
374
+ **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]
375
+ **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]
376
+ **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]
377
+ **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]
378
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
379
+ **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]
380
+ **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]
381
+ **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]
382
+ **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]
383
+ **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]
384
+ **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]
385
+ **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]
386
+ **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]
387
+ **clusters** | [**Array&lt;String&gt;**](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]
388
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
294
389
  **story_id** | **Integer**| A story id | [optional]
295
390
  **story_url** | **String**| An article or webpage | [optional]
296
391
  **story_title** | **String**| Title of the article | [optional]
297
392
  **story_body** | **String**| Body of the article | [optional]
298
- **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]
299
- **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] [enum: auto, en, de, fr, it, es, pt]
300
- **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
393
+ **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]
394
+ **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 &#39;auto&#39;]
395
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
301
396
 
302
397
  ### Return type
303
398
 
@@ -305,223 +400,232 @@ Name | Type | Description | Notes
305
400
 
306
401
  ### Authorization
307
402
 
308
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
403
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
309
404
 
310
405
  ### HTTP request headers
311
406
 
312
- - **Content-Type**: application/x-www-form-urlencoded
313
- - **Accept**: application/json, text/xml
407
+ - **Content-Type**: Not defined
408
+ - **Accept**: application/json, text/xml
314
409
 
315
410
 
411
+ ## list_histograms
316
412
 
317
- # **list_histograms**
318
413
  > Histograms list_histograms(opts)
319
414
 
320
415
  List histograms
321
416
 
322
- This endpoint is used for getting histograms based on the `field` parameter passed to the API.
417
+ 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.
323
418
 
324
419
  ### Example
420
+
325
421
  ```ruby
326
422
  # load the gem
327
423
  require 'aylien_news_api'
328
-
329
424
  # setup authorization
330
425
  AylienNewsApi.configure do |config|
331
426
  # Configure API key authorization: app_id
332
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
427
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
428
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
429
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
333
430
 
334
431
  # Configure API key authorization: app_key
335
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
432
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
434
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
336
435
  end
337
436
 
338
437
  api_instance = AylienNewsApi::DefaultApi.new
339
-
340
- opts = {
341
- id: [56],
342
- not_id: [56],
343
- title: "title_example",
344
- body: "body_example",
345
- text: "text_example",
346
- language: ["language_example"],
347
- not_language: ["not_language_example"],
348
- published_at_start: "published_at_start_example",
349
- published_at_end: "published_at_end_example",
350
- categories_taxonomy: "categories_taxonomy_example",
351
- categories_confident: true,
352
- categories_id: ["categories_id_example"],
353
- not_categories_id: ["not_categories_id_example"],
354
- categories_level: [56],
355
- not_categories_level: [56],
356
- entities_title_text: ["entities_title_text_example"],
357
- not_entities_title_text: ["not_entities_title_text_example"],
358
- entities_title_type: ["entities_title_type_example"],
359
- not_entities_title_type: ["not_entities_title_type_example"],
360
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
361
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
362
- entities_body_text: ["entities_body_text_example"],
363
- not_entities_body_text: ["not_entities_body_text_example"],
364
- entities_body_type: ["entities_body_type_example"],
365
- not_entities_body_type: ["not_entities_body_type_example"],
366
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
367
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
368
- sentiment_title_polarity: "sentiment_title_polarity_example",
369
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
370
- sentiment_body_polarity: "sentiment_body_polarity_example",
371
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
372
- media_images_count_min: 56,
373
- media_images_count_max: 56,
374
- media_images_width_min: 56,
375
- media_images_width_max: 56,
376
- media_images_height_min: 56,
377
- media_images_height_max: 56,
378
- media_images_content_length_min: 56,
379
- media_images_content_length_max: 56,
380
- media_images_format: ["media_images_format_example"],
381
- not_media_images_format: ["not_media_images_format_example"],
382
- media_videos_count_min: 56,
383
- media_videos_count_max: 56,
384
- author_id: [56],
385
- not_author_id: [56],
386
- author_name: "author_name_example",
387
- not_author_name: "not_author_name_example",
388
- source_id: [56],
389
- not_source_id: [56],
390
- source_name: ["source_name_example"],
391
- not_source_name: ["not_source_name_example"],
392
- source_domain: ["source_domain_example"],
393
- not_source_domain: ["not_source_domain_example"],
394
- source_locations_country: ["source_locations_country_example"],
395
- not_source_locations_country: ["not_source_locations_country_example"],
396
- source_locations_state: ["source_locations_state_example"],
397
- not_source_locations_state: ["not_source_locations_state_example"],
398
- source_locations_city: ["source_locations_city_example"],
399
- not_source_locations_city: ["not_source_locations_city_example"],
400
- source_scopes_country: ["source_scopes_country_example"],
401
- not_source_scopes_country: ["not_source_scopes_country_example"],
402
- source_scopes_state: ["source_scopes_state_example"],
403
- not_source_scopes_state: ["not_source_scopes_state_example"],
404
- source_scopes_city: ["source_scopes_city_example"],
405
- not_source_scopes_city: ["not_source_scopes_city_example"],
406
- source_scopes_level: ["source_scopes_level_example"],
407
- not_source_scopes_level: ["not_source_scopes_level_example"],
408
- source_links_in_count_min: 56,
409
- source_links_in_count_max: 56,
410
- source_rankings_alexa_rank_min: 56,
411
- source_rankings_alexa_rank_max: 56,
412
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
413
- social_shares_count_facebook_min: 56,
414
- social_shares_count_facebook_max: 56,
415
- social_shares_count_google_plus_min: 56,
416
- social_shares_count_google_plus_max: 56,
417
- social_shares_count_linkedin_min: 56,
418
- social_shares_count_linkedin_max: 56,
419
- social_shares_count_reddit_min: 56,
420
- social_shares_count_reddit_max: 56,
421
- interval_start: 56,
422
- interval_end: 56,
423
- interval_width: 56,
424
- field: "social_shares_count"
438
+ opts = {
439
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
440
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
441
+ 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).
442
+ 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).
443
+ 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).
444
+ 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).
445
+ 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).
446
+ 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).
447
+ 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.
448
+ 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.
449
+ 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).
450
+ 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).
451
+ 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).
452
+ 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).
453
+ 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).
454
+ 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).
455
+ 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).
456
+ 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).
457
+ 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).
458
+ 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).
459
+ 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).
460
+ 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).
461
+ 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).
462
+ 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).
463
+ 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).
464
+ 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).
465
+ 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).
466
+ 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).
467
+ 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).
468
+ 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).
469
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
470
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
471
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
472
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
473
+ 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.
474
+ 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.
475
+ 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.
476
+ 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.
477
+ 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.
478
+ 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.
479
+ 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.
480
+ 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.
481
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
482
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
483
+ 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.
484
+ 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.
485
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
486
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
487
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
488
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
489
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
490
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
491
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
492
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
493
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
494
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
495
+ 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).
496
+ 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).
497
+ 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).
498
+ 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).
499
+ 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).
500
+ 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).
501
+ 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).
502
+ 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).
503
+ 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).
504
+ 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).
505
+ 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).
506
+ 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).
507
+ 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).
508
+ 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).
509
+ 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).
510
+ 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).
511
+ 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).
512
+ 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).
513
+ 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).
514
+ 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.
515
+ 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.
516
+ 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.
517
+ 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.
518
+ 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.
519
+ 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.
520
+ 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.
521
+ 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.
522
+ interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
523
+ interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
524
+ interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
525
+ field: 'social_shares_count' # String | This parameter is used for specifying the y-axis variable for the histogram.
425
526
  }
426
527
 
427
528
  begin
428
529
  #List histograms
429
530
  result = api_instance.list_histograms(opts)
430
- puts result
531
+ p result
431
532
  rescue AylienNewsApi::ApiError => e
432
533
  puts "Exception when calling DefaultApi->list_histograms: #{e}"
433
- puts e.response_body
434
534
  end
435
535
  ```
436
536
 
437
537
  ### Parameters
438
538
 
539
+
439
540
  Name | Type | Description | Notes
440
541
  ------------- | ------------- | ------------- | -------------
441
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
442
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
443
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
444
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
445
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
446
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
447
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
448
- **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]
449
- **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]
450
- **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] [enum: iab-qag, iptc-subjectcode]
451
- **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]
452
- **categories_id** | **Array&lt;String&gt;**| 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]
453
- **not_categories_id** | **Array&lt;String&gt;**| 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]
454
- **categories_level** | **Array&lt;Integer&gt;**| 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]
455
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
456
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
457
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
458
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
459
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
460
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
461
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
462
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
463
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
464
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
465
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
466
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
467
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
468
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
469
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
470
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
471
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
472
- **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]
473
- **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]
474
- **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]
475
- **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]
476
- **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]
477
- **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]
478
- **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]
479
- **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]
480
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
481
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
482
- **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]
483
- **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]
484
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
485
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
486
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
487
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
488
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
489
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
490
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
491
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
492
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
493
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
494
- **source_locations_country** | **Array&lt;String&gt;**| 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]
495
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
496
- **source_locations_state** | **Array&lt;String&gt;**| 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]
497
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
498
- **source_locations_city** | **Array&lt;String&gt;**| 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]
499
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
500
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
501
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
502
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
503
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
504
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
505
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
506
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
507
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
508
- **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]
509
- **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]
510
- **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]
511
- **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]
512
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
513
- **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]
514
- **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]
515
- **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]
516
- **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]
517
- **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]
518
- **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]
519
- **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]
520
- **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]
521
- **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
522
- **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
523
- **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
524
- **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to social_shares_count] [enum: social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.reddit, social_shares_count.google_plus, characters_count, words_count, sentences_count, paragraphs_count, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW]
542
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
543
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
544
+ **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]
545
+ **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]
546
+ **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]
547
+ **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]
548
+ **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]
549
+ **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]
550
+ **language** | [**Array&lt;String&gt;**](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]
551
+ **not_language** | [**Array&lt;String&gt;**](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]
552
+ **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]
553
+ **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]
554
+ **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]
555
+ **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]
556
+ **categories_id** | [**Array&lt;String&gt;**](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]
557
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
558
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
559
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
560
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
561
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
562
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
563
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
564
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
565
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
566
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
567
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
568
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
569
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
570
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
571
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
572
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
573
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
574
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
575
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
576
+ **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]
577
+ **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]
578
+ **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]
579
+ **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]
580
+ **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]
581
+ **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]
582
+ **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]
583
+ **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]
584
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
585
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
586
+ **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]
587
+ **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]
588
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
589
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
590
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
591
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
592
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
593
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
594
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
595
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
596
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
597
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
598
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
599
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
600
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
601
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
602
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
603
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
604
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
605
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
606
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
607
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
608
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
609
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
610
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
611
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
612
+ **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]
613
+ **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]
614
+ **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]
615
+ **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]
616
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
617
+ **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]
618
+ **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]
619
+ **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]
620
+ **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]
621
+ **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]
622
+ **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]
623
+ **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]
624
+ **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]
625
+ **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
626
+ **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
627
+ **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
628
+ **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to &#39;social_shares_count&#39;]
525
629
 
526
630
  ### Return type
527
631
 
@@ -529,235 +633,242 @@ Name | Type | Description | Notes
529
633
 
530
634
  ### Authorization
531
635
 
532
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
636
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
533
637
 
534
638
  ### HTTP request headers
535
639
 
536
- - **Content-Type**: application/x-www-form-urlencoded
537
- - **Accept**: application/json, text/xml
640
+ - **Content-Type**: Not defined
641
+ - **Accept**: application/json, text/xml
538
642
 
539
643
 
644
+ ## list_related_stories
540
645
 
541
- # **list_related_stories**
542
646
  > RelatedStories list_related_stories(opts)
543
647
 
544
648
  List related stories
545
649
 
546
- This endpoint is used for finding related stories based on the parameters provided. The maximum number of related stories returned is 100.
650
+ This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.
547
651
 
548
652
  ### Example
653
+
549
654
  ```ruby
550
655
  # load the gem
551
656
  require 'aylien_news_api'
552
-
553
657
  # setup authorization
554
658
  AylienNewsApi.configure do |config|
555
659
  # Configure API key authorization: app_id
556
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
660
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
661
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
662
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
557
663
 
558
664
  # Configure API key authorization: app_key
559
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
665
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
666
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
667
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
560
668
  end
561
669
 
562
670
  api_instance = AylienNewsApi::DefaultApi.new
563
-
564
- opts = {
565
- id: [56],
566
- not_id: [56],
567
- title: "title_example",
568
- body: "body_example",
569
- text: "text_example",
570
- language: ["language_example"],
571
- not_language: ["not_language_example"],
572
- published_at_start: "published_at_start_example",
573
- published_at_end: "published_at_end_example",
574
- categories_taxonomy: "categories_taxonomy_example",
575
- categories_confident: true,
576
- categories_id: ["categories_id_example"],
577
- not_categories_id: ["not_categories_id_example"],
578
- categories_level: [56],
579
- not_categories_level: [56],
580
- entities_title_text: ["entities_title_text_example"],
581
- not_entities_title_text: ["not_entities_title_text_example"],
582
- entities_title_type: ["entities_title_type_example"],
583
- not_entities_title_type: ["not_entities_title_type_example"],
584
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
585
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
586
- entities_body_text: ["entities_body_text_example"],
587
- not_entities_body_text: ["not_entities_body_text_example"],
588
- entities_body_type: ["entities_body_type_example"],
589
- not_entities_body_type: ["not_entities_body_type_example"],
590
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
591
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
592
- sentiment_title_polarity: "sentiment_title_polarity_example",
593
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
594
- sentiment_body_polarity: "sentiment_body_polarity_example",
595
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
596
- media_images_count_min: 56,
597
- media_images_count_max: 56,
598
- media_images_width_min: 56,
599
- media_images_width_max: 56,
600
- media_images_height_min: 56,
601
- media_images_height_max: 56,
602
- media_images_content_length_min: 56,
603
- media_images_content_length_max: 56,
604
- media_images_format: ["media_images_format_example"],
605
- not_media_images_format: ["not_media_images_format_example"],
606
- media_videos_count_min: 56,
607
- media_videos_count_max: 56,
608
- author_id: [56],
609
- not_author_id: [56],
610
- author_name: "author_name_example",
611
- not_author_name: "not_author_name_example",
612
- source_id: [56],
613
- not_source_id: [56],
614
- source_name: ["source_name_example"],
615
- not_source_name: ["not_source_name_example"],
616
- source_domain: ["source_domain_example"],
617
- not_source_domain: ["not_source_domain_example"],
618
- source_locations_country: ["source_locations_country_example"],
619
- not_source_locations_country: ["not_source_locations_country_example"],
620
- source_locations_state: ["source_locations_state_example"],
621
- not_source_locations_state: ["not_source_locations_state_example"],
622
- source_locations_city: ["source_locations_city_example"],
623
- not_source_locations_city: ["not_source_locations_city_example"],
624
- source_scopes_country: ["source_scopes_country_example"],
625
- not_source_scopes_country: ["not_source_scopes_country_example"],
626
- source_scopes_state: ["source_scopes_state_example"],
627
- not_source_scopes_state: ["not_source_scopes_state_example"],
628
- source_scopes_city: ["source_scopes_city_example"],
629
- not_source_scopes_city: ["not_source_scopes_city_example"],
630
- source_scopes_level: ["source_scopes_level_example"],
631
- not_source_scopes_level: ["not_source_scopes_level_example"],
632
- source_links_in_count_min: 56,
633
- source_links_in_count_max: 56,
634
- source_rankings_alexa_rank_min: 56,
635
- source_rankings_alexa_rank_max: 56,
636
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
637
- social_shares_count_facebook_min: 56,
638
- social_shares_count_facebook_max: 56,
639
- social_shares_count_google_plus_min: 56,
640
- social_shares_count_google_plus_max: 56,
641
- social_shares_count_linkedin_min: 56,
642
- social_shares_count_linkedin_max: 56,
643
- social_shares_count_reddit_min: 56,
644
- social_shares_count_reddit_max: 56,
645
- cluster: false,
646
- cluster_algorithm: "lingo",
647
- _return: ["_return_example"],
648
- story_id: 789,
649
- story_url: "story_url_example",
650
- story_title: "story_title_example",
651
- story_body: "story_body_example",
652
- boost_by: "boost_by_example",
653
- story_language: "auto",
654
- per_page: 3
671
+ opts = {
672
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
673
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
674
+ 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).
675
+ 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).
676
+ 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).
677
+ 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).
678
+ 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).
679
+ 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).
680
+ 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.
681
+ 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.
682
+ 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).
683
+ 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).
684
+ 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).
685
+ 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).
686
+ 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).
687
+ 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).
688
+ 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).
689
+ 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).
690
+ 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).
691
+ 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).
692
+ 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).
693
+ 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).
694
+ 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).
695
+ 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).
696
+ 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).
697
+ 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).
698
+ 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).
699
+ 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).
700
+ 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).
701
+ 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).
702
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
703
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
704
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
705
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
706
+ 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.
707
+ 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.
708
+ 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.
709
+ 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.
710
+ 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.
711
+ 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.
712
+ 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.
713
+ 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.
714
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
715
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
716
+ 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.
717
+ 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.
718
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
719
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
720
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
721
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
722
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
723
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
724
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
725
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
726
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
727
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
728
+ 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).
729
+ 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).
730
+ 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).
731
+ 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).
732
+ 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).
733
+ 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).
734
+ 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).
735
+ 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).
736
+ 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).
737
+ 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).
738
+ 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).
739
+ 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).
740
+ 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).
741
+ 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).
742
+ 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).
743
+ 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).
744
+ 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).
745
+ 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).
746
+ 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).
747
+ 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.
748
+ 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.
749
+ 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.
750
+ 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.
751
+ 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.
752
+ 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.
753
+ 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.
754
+ 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.
755
+ 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).
756
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
757
+ story_id: 56, # Integer | A story id
758
+ story_url: 'story_url_example', # String | An article or webpage
759
+ story_title: 'story_title_example', # String | Title of the article
760
+ story_body: 'story_body_example', # String | Body of the article
761
+ boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
762
+ 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.
763
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
655
764
  }
656
765
 
657
766
  begin
658
767
  #List related stories
659
768
  result = api_instance.list_related_stories(opts)
660
- puts result
769
+ p result
661
770
  rescue AylienNewsApi::ApiError => e
662
771
  puts "Exception when calling DefaultApi->list_related_stories: #{e}"
663
- puts e.response_body
664
772
  end
665
773
  ```
666
774
 
667
775
  ### Parameters
668
776
 
777
+
669
778
  Name | Type | Description | Notes
670
779
  ------------- | ------------- | ------------- | -------------
671
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
672
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
673
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
674
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
675
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
676
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
677
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
678
- **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]
679
- **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]
680
- **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] [enum: iab-qag, iptc-subjectcode]
681
- **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]
682
- **categories_id** | **Array&lt;String&gt;**| 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]
683
- **not_categories_id** | **Array&lt;String&gt;**| 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]
684
- **categories_level** | **Array&lt;Integer&gt;**| 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]
685
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
686
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
687
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
688
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
689
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
690
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
691
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
692
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
693
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
694
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
695
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
696
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
697
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
698
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
699
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
700
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
701
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
702
- **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]
703
- **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]
704
- **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]
705
- **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]
706
- **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]
707
- **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]
708
- **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]
709
- **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]
710
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
711
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
712
- **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]
713
- **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]
714
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
715
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
716
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
717
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
718
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
719
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
720
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
721
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
722
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
723
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
724
- **source_locations_country** | **Array&lt;String&gt;**| 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]
725
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
726
- **source_locations_state** | **Array&lt;String&gt;**| 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]
727
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
728
- **source_locations_city** | **Array&lt;String&gt;**| 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]
729
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
730
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
731
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
732
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
733
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
734
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
735
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
736
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
737
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
738
- **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]
739
- **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]
740
- **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]
741
- **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]
742
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
743
- **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]
744
- **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]
745
- **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]
746
- **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]
747
- **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]
748
- **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]
749
- **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]
750
- **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]
751
- **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
752
- **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. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
753
- **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links]
780
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
781
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
782
+ **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]
783
+ **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]
784
+ **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]
785
+ **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]
786
+ **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]
787
+ **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]
788
+ **language** | [**Array&lt;String&gt;**](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]
789
+ **not_language** | [**Array&lt;String&gt;**](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]
790
+ **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]
791
+ **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]
792
+ **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]
793
+ **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]
794
+ **categories_id** | [**Array&lt;String&gt;**](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]
795
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
796
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
797
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
798
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
799
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
800
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
801
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
802
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
803
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
804
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
805
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
806
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
807
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
808
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
809
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
810
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
811
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
812
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
813
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
814
+ **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]
815
+ **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]
816
+ **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]
817
+ **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]
818
+ **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]
819
+ **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]
820
+ **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]
821
+ **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]
822
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
823
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
824
+ **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]
825
+ **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]
826
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
827
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
828
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
829
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
830
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
831
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
832
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
833
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
834
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
835
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
836
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
837
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
838
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
839
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
840
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
841
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
842
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
843
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
844
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
845
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
846
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
847
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
848
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
849
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
850
+ **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]
851
+ **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]
852
+ **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]
853
+ **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]
854
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
855
+ **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]
856
+ **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]
857
+ **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]
858
+ **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]
859
+ **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]
860
+ **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]
861
+ **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]
862
+ **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]
863
+ **clusters** | [**Array&lt;String&gt;**](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]
864
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
754
865
  **story_id** | **Integer**| A story id | [optional]
755
866
  **story_url** | **String**| An article or webpage | [optional]
756
867
  **story_title** | **String**| Title of the article | [optional]
757
868
  **story_body** | **String**| Body of the article | [optional]
758
- **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional] [enum: recency, popularity]
759
- **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] [enum: auto, en, de, fr, it, es, pt]
760
- **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
869
+ **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
870
+ **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 &#39;auto&#39;]
871
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
761
872
 
762
873
  ### Return type
763
874
 
@@ -765,229 +876,236 @@ Name | Type | Description | Notes
765
876
 
766
877
  ### Authorization
767
878
 
768
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
879
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
769
880
 
770
881
  ### HTTP request headers
771
882
 
772
- - **Content-Type**: application/x-www-form-urlencoded
773
- - **Accept**: application/json, text/xml
883
+ - **Content-Type**: Not defined
884
+ - **Accept**: application/json, text/xml
774
885
 
775
886
 
887
+ ## list_stories
776
888
 
777
- # **list_stories**
778
889
  > Stories list_stories(opts)
779
890
 
780
891
  List Stories
781
892
 
782
- This endpoint is used for getting a list of stories.
893
+ 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.
783
894
 
784
895
  ### Example
896
+
785
897
  ```ruby
786
898
  # load the gem
787
899
  require 'aylien_news_api'
788
-
789
900
  # setup authorization
790
901
  AylienNewsApi.configure do |config|
791
902
  # Configure API key authorization: app_id
792
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
903
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
904
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
905
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
793
906
 
794
907
  # Configure API key authorization: app_key
795
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
908
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
909
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
910
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
796
911
  end
797
912
 
798
913
  api_instance = AylienNewsApi::DefaultApi.new
799
-
800
- opts = {
801
- id: [56],
802
- not_id: [56],
803
- title: "title_example",
804
- body: "body_example",
805
- text: "text_example",
806
- language: ["language_example"],
807
- not_language: ["not_language_example"],
808
- published_at_start: "published_at_start_example",
809
- published_at_end: "published_at_end_example",
810
- categories_taxonomy: "categories_taxonomy_example",
811
- categories_confident: true,
812
- categories_id: ["categories_id_example"],
813
- not_categories_id: ["not_categories_id_example"],
814
- categories_level: [56],
815
- not_categories_level: [56],
816
- entities_title_text: ["entities_title_text_example"],
817
- not_entities_title_text: ["not_entities_title_text_example"],
818
- entities_title_type: ["entities_title_type_example"],
819
- not_entities_title_type: ["not_entities_title_type_example"],
820
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
821
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
822
- entities_body_text: ["entities_body_text_example"],
823
- not_entities_body_text: ["not_entities_body_text_example"],
824
- entities_body_type: ["entities_body_type_example"],
825
- not_entities_body_type: ["not_entities_body_type_example"],
826
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
827
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
828
- sentiment_title_polarity: "sentiment_title_polarity_example",
829
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
830
- sentiment_body_polarity: "sentiment_body_polarity_example",
831
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
832
- media_images_count_min: 56,
833
- media_images_count_max: 56,
834
- media_images_width_min: 56,
835
- media_images_width_max: 56,
836
- media_images_height_min: 56,
837
- media_images_height_max: 56,
838
- media_images_content_length_min: 56,
839
- media_images_content_length_max: 56,
840
- media_images_format: ["media_images_format_example"],
841
- not_media_images_format: ["not_media_images_format_example"],
842
- media_videos_count_min: 56,
843
- media_videos_count_max: 56,
844
- author_id: [56],
845
- not_author_id: [56],
846
- author_name: "author_name_example",
847
- not_author_name: "not_author_name_example",
848
- source_id: [56],
849
- not_source_id: [56],
850
- source_name: ["source_name_example"],
851
- not_source_name: ["not_source_name_example"],
852
- source_domain: ["source_domain_example"],
853
- not_source_domain: ["not_source_domain_example"],
854
- source_locations_country: ["source_locations_country_example"],
855
- not_source_locations_country: ["not_source_locations_country_example"],
856
- source_locations_state: ["source_locations_state_example"],
857
- not_source_locations_state: ["not_source_locations_state_example"],
858
- source_locations_city: ["source_locations_city_example"],
859
- not_source_locations_city: ["not_source_locations_city_example"],
860
- source_scopes_country: ["source_scopes_country_example"],
861
- not_source_scopes_country: ["not_source_scopes_country_example"],
862
- source_scopes_state: ["source_scopes_state_example"],
863
- not_source_scopes_state: ["not_source_scopes_state_example"],
864
- source_scopes_city: ["source_scopes_city_example"],
865
- not_source_scopes_city: ["not_source_scopes_city_example"],
866
- source_scopes_level: ["source_scopes_level_example"],
867
- not_source_scopes_level: ["not_source_scopes_level_example"],
868
- source_links_in_count_min: 56,
869
- source_links_in_count_max: 56,
870
- source_rankings_alexa_rank_min: 56,
871
- source_rankings_alexa_rank_max: 56,
872
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
873
- social_shares_count_facebook_min: 56,
874
- social_shares_count_facebook_max: 56,
875
- social_shares_count_google_plus_min: 56,
876
- social_shares_count_google_plus_max: 56,
877
- social_shares_count_linkedin_min: 56,
878
- social_shares_count_linkedin_max: 56,
879
- social_shares_count_reddit_min: 56,
880
- social_shares_count_reddit_max: 56,
881
- cluster: false,
882
- cluster_algorithm: "lingo",
883
- _return: ["_return_example"],
884
- sort_by: "published_at",
885
- sort_direction: "desc",
886
- cursor: "*",
887
- per_page: 10
914
+ opts = {
915
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
916
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
917
+ 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).
918
+ 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).
919
+ 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).
920
+ 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).
921
+ 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).
922
+ 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).
923
+ 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.
924
+ 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.
925
+ 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).
926
+ 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).
927
+ 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).
928
+ 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).
929
+ 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).
930
+ 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).
931
+ 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).
932
+ 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).
933
+ 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).
934
+ 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).
935
+ 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).
936
+ 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).
937
+ 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).
938
+ 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).
939
+ 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).
940
+ 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).
941
+ 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).
942
+ 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).
943
+ 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).
944
+ 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).
945
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
946
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
947
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
948
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
949
+ 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.
950
+ 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.
951
+ 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.
952
+ 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.
953
+ 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.
954
+ 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.
955
+ 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.
956
+ 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.
957
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
958
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
959
+ 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.
960
+ 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.
961
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
962
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
963
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
964
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
965
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
966
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
967
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
968
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
969
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
970
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
971
+ 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).
972
+ 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).
973
+ 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).
974
+ 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).
975
+ 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).
976
+ 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).
977
+ 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).
978
+ 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).
979
+ 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).
980
+ 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).
981
+ 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).
982
+ 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).
983
+ 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).
984
+ 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).
985
+ 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).
986
+ 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).
987
+ 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).
988
+ 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).
989
+ 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).
990
+ 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.
991
+ 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.
992
+ 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.
993
+ 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.
994
+ 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.
995
+ 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.
996
+ 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.
997
+ 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.
998
+ 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).
999
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
1000
+ 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).
1001
+ 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).
1002
+ 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).
1003
+ 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)
888
1004
  }
889
1005
 
890
1006
  begin
891
1007
  #List Stories
892
1008
  result = api_instance.list_stories(opts)
893
- puts result
1009
+ p result
894
1010
  rescue AylienNewsApi::ApiError => e
895
1011
  puts "Exception when calling DefaultApi->list_stories: #{e}"
896
- puts e.response_body
897
1012
  end
898
1013
  ```
899
1014
 
900
1015
  ### Parameters
901
1016
 
1017
+
902
1018
  Name | Type | Description | Notes
903
1019
  ------------- | ------------- | ------------- | -------------
904
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
905
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
906
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
907
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
908
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
909
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
910
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
911
- **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]
912
- **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]
913
- **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] [enum: iab-qag, iptc-subjectcode]
914
- **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]
915
- **categories_id** | **Array&lt;String&gt;**| 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]
916
- **not_categories_id** | **Array&lt;String&gt;**| 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]
917
- **categories_level** | **Array&lt;Integer&gt;**| 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]
918
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
919
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
920
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
921
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
922
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
923
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
924
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
925
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
926
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
927
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
928
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
929
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
930
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
931
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
932
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
933
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
934
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
935
- **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]
936
- **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]
937
- **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]
938
- **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]
939
- **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]
940
- **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]
941
- **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]
942
- **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]
943
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
944
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
945
- **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]
946
- **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]
947
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
948
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
949
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
950
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
951
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
952
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
953
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
954
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
955
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
956
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
957
- **source_locations_country** | **Array&lt;String&gt;**| 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]
958
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
959
- **source_locations_state** | **Array&lt;String&gt;**| 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]
960
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
961
- **source_locations_city** | **Array&lt;String&gt;**| 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]
962
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
963
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
964
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
965
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
966
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
967
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
968
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
969
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
970
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
971
- **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]
972
- **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]
973
- **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]
974
- **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]
975
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
976
- **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]
977
- **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]
978
- **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]
979
- **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]
980
- **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]
981
- **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]
982
- **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]
983
- **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]
984
- **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
985
- **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. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
986
- **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links]
987
- **sort_by** | **String**| This parameter is used for changing the order column of the results. | [optional] [default to published_at] [enum: relevance, recency, hotness, published_at, social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.google_plus, social_shares_count.reddit, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW]
988
- **sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc] [enum: asc, desc]
989
- **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 *]
990
- **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]
1020
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
1021
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
1022
+ **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]
1023
+ **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]
1024
+ **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]
1025
+ **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]
1026
+ **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]
1027
+ **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]
1028
+ **language** | [**Array&lt;String&gt;**](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]
1029
+ **not_language** | [**Array&lt;String&gt;**](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]
1030
+ **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]
1031
+ **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]
1032
+ **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]
1033
+ **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]
1034
+ **categories_id** | [**Array&lt;String&gt;**](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]
1035
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
1036
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
1037
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
1038
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1039
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1040
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1041
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1042
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1043
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1044
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1045
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1046
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1047
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1048
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1049
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1050
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1051
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1052
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
1053
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
1054
+ **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]
1055
+ **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]
1056
+ **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]
1057
+ **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]
1058
+ **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]
1059
+ **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]
1060
+ **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]
1061
+ **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]
1062
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
1063
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
1064
+ **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]
1065
+ **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]
1066
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
1067
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1068
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1069
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1070
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
1071
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1072
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1073
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1074
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1075
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1076
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
1077
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
1078
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
1079
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
1080
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
1081
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
1082
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
1083
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
1084
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
1085
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
1086
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
1087
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
1088
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
1089
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
1090
+ **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]
1091
+ **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]
1092
+ **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]
1093
+ **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]
1094
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
1095
+ **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]
1096
+ **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]
1097
+ **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]
1098
+ **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]
1099
+ **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]
1100
+ **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]
1101
+ **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]
1102
+ **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]
1103
+ **clusters** | [**Array&lt;String&gt;**](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]
1104
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
1105
+ **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 &#39;published_at&#39;]
1106
+ **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 &#39;desc&#39;]
1107
+ **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 &#39;*&#39;]
1108
+ **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]
991
1109
 
992
1110
  ### Return type
993
1111
 
@@ -995,217 +1113,226 @@ Name | Type | Description | Notes
995
1113
 
996
1114
  ### Authorization
997
1115
 
998
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
1116
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
999
1117
 
1000
1118
  ### HTTP request headers
1001
1119
 
1002
- - **Content-Type**: application/x-www-form-urlencoded
1003
- - **Accept**: application/json, text/xml
1120
+ - **Content-Type**: Not defined
1121
+ - **Accept**: application/json, text/xml
1004
1122
 
1005
1123
 
1124
+ ## list_time_series
1006
1125
 
1007
- # **list_time_series**
1008
1126
  > TimeSeriesList list_time_series(opts)
1009
1127
 
1010
1128
  List time series
1011
1129
 
1012
- This endpoint is used for getting time series by stories.
1130
+ 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.
1013
1131
 
1014
1132
  ### Example
1133
+
1015
1134
  ```ruby
1016
1135
  # load the gem
1017
1136
  require 'aylien_news_api'
1018
-
1019
1137
  # setup authorization
1020
1138
  AylienNewsApi.configure do |config|
1021
1139
  # Configure API key authorization: app_id
1022
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
1140
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
1141
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1142
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
1023
1143
 
1024
1144
  # Configure API key authorization: app_key
1025
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
1145
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
1146
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1147
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
1026
1148
  end
1027
1149
 
1028
1150
  api_instance = AylienNewsApi::DefaultApi.new
1029
-
1030
- opts = {
1031
- id: [56],
1032
- not_id: [56],
1033
- title: "title_example",
1034
- body: "body_example",
1035
- text: "text_example",
1036
- language: ["language_example"],
1037
- not_language: ["not_language_example"],
1038
- categories_taxonomy: "categories_taxonomy_example",
1039
- categories_confident: true,
1040
- categories_id: ["categories_id_example"],
1041
- not_categories_id: ["not_categories_id_example"],
1042
- categories_level: [56],
1043
- not_categories_level: [56],
1044
- entities_title_text: ["entities_title_text_example"],
1045
- not_entities_title_text: ["not_entities_title_text_example"],
1046
- entities_title_type: ["entities_title_type_example"],
1047
- not_entities_title_type: ["not_entities_title_type_example"],
1048
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
1049
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
1050
- entities_body_text: ["entities_body_text_example"],
1051
- not_entities_body_text: ["not_entities_body_text_example"],
1052
- entities_body_type: ["entities_body_type_example"],
1053
- not_entities_body_type: ["not_entities_body_type_example"],
1054
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
1055
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
1056
- sentiment_title_polarity: "sentiment_title_polarity_example",
1057
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
1058
- sentiment_body_polarity: "sentiment_body_polarity_example",
1059
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
1060
- media_images_count_min: 56,
1061
- media_images_count_max: 56,
1062
- media_images_width_min: 56,
1063
- media_images_width_max: 56,
1064
- media_images_height_min: 56,
1065
- media_images_height_max: 56,
1066
- media_images_content_length_min: 56,
1067
- media_images_content_length_max: 56,
1068
- media_images_format: ["media_images_format_example"],
1069
- not_media_images_format: ["not_media_images_format_example"],
1070
- media_videos_count_min: 56,
1071
- media_videos_count_max: 56,
1072
- author_id: [56],
1073
- not_author_id: [56],
1074
- author_name: "author_name_example",
1075
- not_author_name: "not_author_name_example",
1076
- source_id: [56],
1077
- not_source_id: [56],
1078
- source_name: ["source_name_example"],
1079
- not_source_name: ["not_source_name_example"],
1080
- source_domain: ["source_domain_example"],
1081
- not_source_domain: ["not_source_domain_example"],
1082
- source_locations_country: ["source_locations_country_example"],
1083
- not_source_locations_country: ["not_source_locations_country_example"],
1084
- source_locations_state: ["source_locations_state_example"],
1085
- not_source_locations_state: ["not_source_locations_state_example"],
1086
- source_locations_city: ["source_locations_city_example"],
1087
- not_source_locations_city: ["not_source_locations_city_example"],
1088
- source_scopes_country: ["source_scopes_country_example"],
1089
- not_source_scopes_country: ["not_source_scopes_country_example"],
1090
- source_scopes_state: ["source_scopes_state_example"],
1091
- not_source_scopes_state: ["not_source_scopes_state_example"],
1092
- source_scopes_city: ["source_scopes_city_example"],
1093
- not_source_scopes_city: ["not_source_scopes_city_example"],
1094
- source_scopes_level: ["source_scopes_level_example"],
1095
- not_source_scopes_level: ["not_source_scopes_level_example"],
1096
- source_links_in_count_min: 56,
1097
- source_links_in_count_max: 56,
1098
- source_rankings_alexa_rank_min: 56,
1099
- source_rankings_alexa_rank_max: 56,
1100
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
1101
- social_shares_count_facebook_min: 56,
1102
- social_shares_count_facebook_max: 56,
1103
- social_shares_count_google_plus_min: 56,
1104
- social_shares_count_google_plus_max: 56,
1105
- social_shares_count_linkedin_min: 56,
1106
- social_shares_count_linkedin_max: 56,
1107
- social_shares_count_reddit_min: 56,
1108
- social_shares_count_reddit_max: 56,
1109
- published_at_start: "NOW-7DAYS/DAY",
1110
- published_at_end: "NOW/DAY",
1111
- period: "+1DAY"
1151
+ opts = {
1152
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
1153
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
1154
+ 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).
1155
+ 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).
1156
+ 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).
1157
+ 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).
1158
+ 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).
1159
+ 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).
1160
+ 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.
1161
+ 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.
1162
+ 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).
1163
+ 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).
1164
+ 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).
1165
+ 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).
1166
+ 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).
1167
+ 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).
1168
+ 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).
1169
+ 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).
1170
+ 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).
1171
+ 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).
1172
+ 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).
1173
+ 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).
1174
+ 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).
1175
+ 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).
1176
+ 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).
1177
+ 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).
1178
+ 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).
1179
+ 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).
1180
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
1181
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
1182
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
1183
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
1184
+ 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.
1185
+ 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.
1186
+ 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.
1187
+ 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.
1188
+ 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.
1189
+ 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.
1190
+ 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.
1191
+ 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.
1192
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
1193
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
1194
+ 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.
1195
+ 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.
1196
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
1197
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
1198
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
1199
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
1200
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
1201
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
1202
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
1203
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
1204
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
1205
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
1206
+ 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).
1207
+ 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).
1208
+ 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).
1209
+ 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).
1210
+ 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).
1211
+ 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).
1212
+ 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).
1213
+ 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).
1214
+ 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).
1215
+ 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).
1216
+ 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).
1217
+ 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).
1218
+ 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).
1219
+ 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).
1220
+ 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).
1221
+ 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).
1222
+ 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).
1223
+ 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).
1224
+ 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).
1225
+ 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.
1226
+ 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.
1227
+ 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.
1228
+ 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.
1229
+ 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.
1230
+ 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.
1231
+ 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.
1232
+ 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.
1233
+ 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).
1234
+ 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).
1235
+ 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).
1112
1236
  }
1113
1237
 
1114
1238
  begin
1115
1239
  #List time series
1116
1240
  result = api_instance.list_time_series(opts)
1117
- puts result
1241
+ p result
1118
1242
  rescue AylienNewsApi::ApiError => e
1119
1243
  puts "Exception when calling DefaultApi->list_time_series: #{e}"
1120
- puts e.response_body
1121
1244
  end
1122
1245
  ```
1123
1246
 
1124
1247
  ### Parameters
1125
1248
 
1249
+
1126
1250
  Name | Type | Description | Notes
1127
1251
  ------------- | ------------- | ------------- | -------------
1128
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
1129
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
1130
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1131
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1132
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1133
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
1134
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
1135
- **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] [enum: iab-qag, iptc-subjectcode]
1136
- **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]
1137
- **categories_id** | **Array&lt;String&gt;**| 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]
1138
- **not_categories_id** | **Array&lt;String&gt;**| 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]
1139
- **categories_level** | **Array&lt;Integer&gt;**| 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]
1140
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
1141
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1142
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1143
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1144
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1145
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
1146
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
1147
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1148
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1149
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1150
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1151
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
1152
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
1153
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1154
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1155
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1156
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1157
- **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]
1158
- **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]
1159
- **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]
1160
- **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]
1161
- **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]
1162
- **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]
1163
- **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]
1164
- **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]
1165
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1166
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1167
- **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]
1168
- **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]
1169
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
1170
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1171
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1172
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1173
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
1174
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1175
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1176
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1177
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1178
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1179
- **source_locations_country** | **Array&lt;String&gt;**| 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]
1180
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
1181
- **source_locations_state** | **Array&lt;String&gt;**| 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]
1182
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
1183
- **source_locations_city** | **Array&lt;String&gt;**| 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]
1184
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
1185
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
1186
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
1187
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
1188
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
1189
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
1190
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
1191
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
1192
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
1193
- **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]
1194
- **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]
1195
- **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]
1196
- **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]
1197
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
1198
- **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]
1199
- **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]
1200
- **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]
1201
- **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]
1202
- **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]
1203
- **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]
1204
- **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]
1205
- **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]
1206
- **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]
1207
- **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]
1208
- **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 &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to +1DAY]
1252
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
1253
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
1254
+ **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]
1255
+ **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]
1256
+ **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]
1257
+ **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]
1258
+ **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]
1259
+ **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]
1260
+ **language** | [**Array&lt;String&gt;**](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]
1261
+ **not_language** | [**Array&lt;String&gt;**](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]
1262
+ **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]
1263
+ **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]
1264
+ **categories_id** | [**Array&lt;String&gt;**](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]
1265
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
1266
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
1267
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
1268
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1269
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1270
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1271
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1272
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1273
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1274
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1275
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1276
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1277
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1278
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1279
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1280
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1281
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1282
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
1283
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
1284
+ **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]
1285
+ **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]
1286
+ **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]
1287
+ **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]
1288
+ **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]
1289
+ **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]
1290
+ **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]
1291
+ **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]
1292
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
1293
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
1294
+ **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]
1295
+ **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]
1296
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
1297
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1298
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1299
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1300
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
1301
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1302
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1303
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1304
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1305
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1306
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
1307
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
1308
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
1309
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
1310
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
1311
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
1312
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
1313
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
1314
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
1315
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
1316
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
1317
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
1318
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
1319
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
1320
+ **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]
1321
+ **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]
1322
+ **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]
1323
+ **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]
1324
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
1325
+ **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]
1326
+ **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]
1327
+ **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]
1328
+ **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]
1329
+ **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]
1330
+ **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]
1331
+ **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]
1332
+ **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]
1333
+ **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 &#39;NOW-7DAYS/DAY&#39;]
1334
+ **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 &#39;NOW/DAY&#39;]
1335
+ **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 &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to &#39;+1DAY&#39;]
1209
1336
 
1210
1337
  ### Return type
1211
1338
 
@@ -1213,218 +1340,226 @@ Name | Type | Description | Notes
1213
1340
 
1214
1341
  ### Authorization
1215
1342
 
1216
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
1343
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
1217
1344
 
1218
1345
  ### HTTP request headers
1219
1346
 
1220
- - **Content-Type**: application/x-www-form-urlencoded
1221
- - **Accept**: application/json, text/xml
1347
+ - **Content-Type**: Not defined
1348
+ - **Accept**: application/json, text/xml
1222
1349
 
1223
1350
 
1351
+ ## list_trends
1224
1352
 
1225
- # **list_trends**
1226
1353
  > Trends list_trends(field, opts)
1227
1354
 
1228
1355
  List trends
1229
1356
 
1230
- This endpoint is used for finding trends based on stories.
1357
+ 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.
1231
1358
 
1232
1359
  ### Example
1360
+
1233
1361
  ```ruby
1234
1362
  # load the gem
1235
1363
  require 'aylien_news_api'
1236
-
1237
1364
  # setup authorization
1238
1365
  AylienNewsApi.configure do |config|
1239
1366
  # Configure API key authorization: app_id
1240
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
1367
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
1368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1369
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
1241
1370
 
1242
1371
  # Configure API key authorization: app_key
1243
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
1372
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
1373
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1374
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
1244
1375
  end
1245
1376
 
1246
1377
  api_instance = AylienNewsApi::DefaultApi.new
1247
-
1248
- field = "field_example"
1249
-
1250
- opts = {
1251
- id: [56],
1252
- not_id: [56],
1253
- title: "title_example",
1254
- body: "body_example",
1255
- text: "text_example",
1256
- language: ["language_example"],
1257
- not_language: ["not_language_example"],
1258
- published_at_start: "published_at_start_example",
1259
- published_at_end: "published_at_end_example",
1260
- categories_taxonomy: "categories_taxonomy_example",
1261
- categories_confident: true,
1262
- categories_id: ["categories_id_example"],
1263
- not_categories_id: ["not_categories_id_example"],
1264
- categories_level: [56],
1265
- not_categories_level: [56],
1266
- entities_title_text: ["entities_title_text_example"],
1267
- not_entities_title_text: ["not_entities_title_text_example"],
1268
- entities_title_type: ["entities_title_type_example"],
1269
- not_entities_title_type: ["not_entities_title_type_example"],
1270
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
1271
- not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
1272
- entities_body_text: ["entities_body_text_example"],
1273
- not_entities_body_text: ["not_entities_body_text_example"],
1274
- entities_body_type: ["entities_body_type_example"],
1275
- not_entities_body_type: ["not_entities_body_type_example"],
1276
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
1277
- not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
1278
- sentiment_title_polarity: "sentiment_title_polarity_example",
1279
- not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
1280
- sentiment_body_polarity: "sentiment_body_polarity_example",
1281
- not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
1282
- media_images_count_min: 56,
1283
- media_images_count_max: 56,
1284
- media_images_width_min: 56,
1285
- media_images_width_max: 56,
1286
- media_images_height_min: 56,
1287
- media_images_height_max: 56,
1288
- media_images_content_length_min: 56,
1289
- media_images_content_length_max: 56,
1290
- media_images_format: ["media_images_format_example"],
1291
- not_media_images_format: ["not_media_images_format_example"],
1292
- media_videos_count_min: 56,
1293
- media_videos_count_max: 56,
1294
- author_id: [56],
1295
- not_author_id: [56],
1296
- author_name: "author_name_example",
1297
- not_author_name: "not_author_name_example",
1298
- source_id: [56],
1299
- not_source_id: [56],
1300
- source_name: ["source_name_example"],
1301
- not_source_name: ["not_source_name_example"],
1302
- source_domain: ["source_domain_example"],
1303
- not_source_domain: ["not_source_domain_example"],
1304
- source_locations_country: ["source_locations_country_example"],
1305
- not_source_locations_country: ["not_source_locations_country_example"],
1306
- source_locations_state: ["source_locations_state_example"],
1307
- not_source_locations_state: ["not_source_locations_state_example"],
1308
- source_locations_city: ["source_locations_city_example"],
1309
- not_source_locations_city: ["not_source_locations_city_example"],
1310
- source_scopes_country: ["source_scopes_country_example"],
1311
- not_source_scopes_country: ["not_source_scopes_country_example"],
1312
- source_scopes_state: ["source_scopes_state_example"],
1313
- not_source_scopes_state: ["not_source_scopes_state_example"],
1314
- source_scopes_city: ["source_scopes_city_example"],
1315
- not_source_scopes_city: ["not_source_scopes_city_example"],
1316
- source_scopes_level: ["source_scopes_level_example"],
1317
- not_source_scopes_level: ["not_source_scopes_level_example"],
1318
- source_links_in_count_min: 56,
1319
- source_links_in_count_max: 56,
1320
- source_rankings_alexa_rank_min: 56,
1321
- source_rankings_alexa_rank_max: 56,
1322
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
1323
- social_shares_count_facebook_min: 56,
1324
- social_shares_count_facebook_max: 56,
1325
- social_shares_count_google_plus_min: 56,
1326
- social_shares_count_google_plus_max: 56,
1327
- social_shares_count_linkedin_min: 56,
1328
- social_shares_count_linkedin_max: 56,
1329
- social_shares_count_reddit_min: 56,
1330
- social_shares_count_reddit_max: 56,
1378
+ field = 'keywords' # String | This parameter is used to specify the trend field.
1379
+ opts = {
1380
+ id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
1381
+ not_id: [56], # Array<Integer> | This parameter is used for excluding stories by story id.
1382
+ 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).
1383
+ 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).
1384
+ 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).
1385
+ 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).
1386
+ 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).
1387
+ 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).
1388
+ 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.
1389
+ 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.
1390
+ 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).
1391
+ 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).
1392
+ 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).
1393
+ 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).
1394
+ 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).
1395
+ 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).
1396
+ 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).
1397
+ 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).
1398
+ 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).
1399
+ 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).
1400
+ 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).
1401
+ 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).
1402
+ 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).
1403
+ 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).
1404
+ 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).
1405
+ 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).
1406
+ 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).
1407
+ 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).
1408
+ 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).
1409
+ 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).
1410
+ sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
1411
+ not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
1412
+ sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
1413
+ not_sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for excluding stories whose body sentiment is the specified value.
1414
+ 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.
1415
+ 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.
1416
+ 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.
1417
+ 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.
1418
+ 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.
1419
+ 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.
1420
+ 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.
1421
+ 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.
1422
+ media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
1423
+ not_media_images_format: ['media_images_format_example'], # Array<String> | This parameter is used for excluding stories whose images format are the specified value.
1424
+ 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.
1425
+ 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.
1426
+ author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
1427
+ not_author_id: [56], # Array<Integer> | This parameter is used for excluding stories whose author id is the specified value.
1428
+ author_name: 'author_name_example', # String | This parameter is used for finding stories whose author full name contains the specified value.
1429
+ not_author_name: 'author_name_example', # String | This parameter is used for excluding stories whose author full name contains the specified value.
1430
+ source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
1431
+ not_source_id: [56], # Array<Integer> | This parameter is used for excluding stories whose source id is the specified value.
1432
+ source_name: ['source_name_example'], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
1433
+ not_source_name: ['source_name_example'], # Array<String> | This parameter is used for excluding stories whose source name contains the specified value.
1434
+ source_domain: ['source_domain_example'], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
1435
+ not_source_domain: ['source_domain_example'], # Array<String> | This parameter is used for excluding stories whose source domain is the specified value.
1436
+ 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).
1437
+ 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).
1438
+ 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).
1439
+ 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).
1440
+ 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).
1441
+ 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).
1442
+ 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).
1443
+ 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).
1444
+ 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).
1445
+ 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).
1446
+ 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).
1447
+ 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).
1448
+ 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).
1449
+ 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).
1450
+ 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).
1451
+ 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).
1452
+ 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).
1453
+ 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).
1454
+ 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).
1455
+ 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.
1456
+ 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.
1457
+ 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.
1458
+ 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.
1459
+ 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.
1460
+ 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.
1461
+ 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.
1462
+ 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.
1331
1463
  }
1332
1464
 
1333
1465
  begin
1334
1466
  #List trends
1335
1467
  result = api_instance.list_trends(field, opts)
1336
- puts result
1468
+ p result
1337
1469
  rescue AylienNewsApi::ApiError => e
1338
1470
  puts "Exception when calling DefaultApi->list_trends: #{e}"
1339
- puts e.response_body
1340
1471
  end
1341
1472
  ```
1342
1473
 
1343
1474
  ### Parameters
1344
1475
 
1476
+
1345
1477
  Name | Type | Description | Notes
1346
1478
  ------------- | ------------- | ------------- | -------------
1347
- **field** | **String**| This parameter is used to specify the trend field. | [enum: author.name, source.name, source.domain, keywords, entities.title.text, entities.title.type, entities.title.links.dbpedia, entities.body.text, entities.body.type, entities.body.links.dbpedia, hashtags, categories.id, sentiment.title.polarity, sentiment.body.polarity]
1348
- **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
1349
- **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
1350
- **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1351
- **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1352
- **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1353
- **language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
1354
- **not_language** | **Array&lt;String&gt;**| 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] [enum: en, de, fr, it, es, pt]
1355
- **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]
1356
- **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]
1357
- **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] [enum: iab-qag, iptc-subjectcode]
1358
- **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]
1359
- **categories_id** | **Array&lt;String&gt;**| 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]
1360
- **not_categories_id** | **Array&lt;String&gt;**| 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]
1361
- **categories_level** | **Array&lt;Integer&gt;**| 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]
1362
- **not_categories_level** | **Array&lt;Integer&gt;**| 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]
1363
- **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1364
- **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1365
- **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1366
- **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1367
- **entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
1368
- **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| 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]
1369
- **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1370
- **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1371
- **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1372
- **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1373
- **entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
1374
- **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| 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]
1375
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1376
- **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1377
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1378
- **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1379
- **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]
1380
- **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]
1381
- **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]
1382
- **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]
1383
- **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]
1384
- **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]
1385
- **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]
1386
- **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]
1387
- **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1388
- **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1389
- **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]
1390
- **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]
1391
- **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
1392
- **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1393
- **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1394
- **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1395
- **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
1396
- **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1397
- **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1398
- **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1399
- **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1400
- **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1401
- **source_locations_country** | **Array&lt;String&gt;**| 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]
1402
- **not_source_locations_country** | **Array&lt;String&gt;**| 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]
1403
- **source_locations_state** | **Array&lt;String&gt;**| 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]
1404
- **not_source_locations_state** | **Array&lt;String&gt;**| 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]
1405
- **source_locations_city** | **Array&lt;String&gt;**| 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]
1406
- **not_source_locations_city** | **Array&lt;String&gt;**| 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]
1407
- **source_scopes_country** | **Array&lt;String&gt;**| 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]
1408
- **not_source_scopes_country** | **Array&lt;String&gt;**| 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]
1409
- **source_scopes_state** | **Array&lt;String&gt;**| 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]
1410
- **not_source_scopes_state** | **Array&lt;String&gt;**| 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]
1411
- **source_scopes_city** | **Array&lt;String&gt;**| 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]
1412
- **not_source_scopes_city** | **Array&lt;String&gt;**| 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]
1413
- **source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
1414
- **not_source_scopes_level** | **Array&lt;String&gt;**| 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] [enum: international, national, local]
1415
- **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]
1416
- **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]
1417
- **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]
1418
- **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]
1419
- **source_rankings_alexa_country** | **Array&lt;String&gt;**| 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]
1420
- **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]
1421
- **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]
1422
- **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]
1423
- **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]
1424
- **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]
1425
- **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]
1426
- **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]
1427
- **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]
1479
+ **field** | **String**| This parameter is used to specify the trend field. |
1480
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
1481
+ **not_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by story id. | [optional]
1482
+ **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]
1483
+ **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]
1484
+ **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]
1485
+ **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]
1486
+ **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]
1487
+ **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]
1488
+ **language** | [**Array&lt;String&gt;**](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]
1489
+ **not_language** | [**Array&lt;String&gt;**](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]
1490
+ **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]
1491
+ **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]
1492
+ **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]
1493
+ **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]
1494
+ **categories_id** | [**Array&lt;String&gt;**](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]
1495
+ **not_categories_id** | [**Array&lt;String&gt;**](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]
1496
+ **categories_level** | [**Array&lt;Integer&gt;**](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]
1497
+ **not_categories_level** | [**Array&lt;Integer&gt;**](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]
1498
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1499
+ **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1500
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1501
+ **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1502
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1503
+ **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](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]
1504
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1505
+ **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1506
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1507
+ **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1508
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1509
+ **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](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]
1510
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1511
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1512
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
1513
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
1514
+ **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]
1515
+ **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]
1516
+ **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]
1517
+ **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]
1518
+ **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]
1519
+ **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]
1520
+ **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]
1521
+ **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]
1522
+ **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
1523
+ **not_media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose images format are the specified value. | [optional]
1524
+ **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]
1525
+ **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]
1526
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
1527
+ **not_author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1528
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1529
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1530
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
1531
+ **not_source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1532
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1533
+ **not_source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1534
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1535
+ **not_source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1536
+ **source_locations_country** | [**Array&lt;String&gt;**](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]
1537
+ **not_source_locations_country** | [**Array&lt;String&gt;**](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]
1538
+ **source_locations_state** | [**Array&lt;String&gt;**](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]
1539
+ **not_source_locations_state** | [**Array&lt;String&gt;**](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]
1540
+ **source_locations_city** | [**Array&lt;String&gt;**](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]
1541
+ **not_source_locations_city** | [**Array&lt;String&gt;**](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]
1542
+ **source_scopes_country** | [**Array&lt;String&gt;**](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]
1543
+ **not_source_scopes_country** | [**Array&lt;String&gt;**](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]
1544
+ **source_scopes_state** | [**Array&lt;String&gt;**](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]
1545
+ **not_source_scopes_state** | [**Array&lt;String&gt;**](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]
1546
+ **source_scopes_city** | [**Array&lt;String&gt;**](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]
1547
+ **not_source_scopes_city** | [**Array&lt;String&gt;**](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]
1548
+ **source_scopes_level** | [**Array&lt;String&gt;**](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]
1549
+ **not_source_scopes_level** | [**Array&lt;String&gt;**](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]
1550
+ **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]
1551
+ **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]
1552
+ **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]
1553
+ **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]
1554
+ **source_rankings_alexa_country** | [**Array&lt;String&gt;**](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]
1555
+ **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]
1556
+ **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]
1557
+ **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]
1558
+ **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]
1559
+ **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]
1560
+ **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]
1561
+ **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]
1562
+ **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]
1428
1563
 
1429
1564
  ### Return type
1430
1565
 
@@ -1432,12 +1567,10 @@ Name | Type | Description | Notes
1432
1567
 
1433
1568
  ### Authorization
1434
1569
 
1435
- [app_key](../README.md#app_key), [app_id](../README.md#app_id)
1570
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
1436
1571
 
1437
1572
  ### HTTP request headers
1438
1573
 
1439
- - **Content-Type**: application/x-www-form-urlencoded
1440
- - **Accept**: application/json, text/xml
1441
-
1442
-
1574
+ - **Content-Type**: Not defined
1575
+ - **Accept**: application/json, text/xml
1443
1576