aylien_news_api 4.0.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/AggregatedSentiment.md +21 -0
- data/docs/DefaultApi.md +353 -1
- data/docs/Entity.md +13 -5
- data/docs/EntityLinks.md +6 -2
- data/docs/EntitySentiment.md +19 -0
- data/docs/EntitySurfaceForm.md +21 -0
- data/docs/ErrorLinks.md +3 -1
- data/docs/Logicals.md +21 -0
- data/docs/NestedEntity.md +33 -0
- data/docs/Parameter.md +127 -0
- data/docs/Query.md +31 -0
- data/docs/RelatedStories.md +5 -1
- data/docs/Stories.md +3 -1
- data/docs/Story.md +3 -1
- data/docs/TimeSeries.md +3 -1
- data/docs/Trend.md +3 -1
- data/docs/Warning.md +21 -0
- data/lib/aylien_news_api.rb +8 -0
- data/lib/aylien_news_api/api/default_api.rb +521 -2
- data/lib/aylien_news_api/models/aggregated_sentiment.rb +228 -0
- data/lib/aylien_news_api/models/entity.rb +68 -28
- data/lib/aylien_news_api/models/entity_links.rb +25 -5
- data/lib/aylien_news_api/models/entity_sentiment.rb +240 -0
- data/lib/aylien_news_api/models/entity_surface_form.rb +244 -0
- data/lib/aylien_news_api/models/error_links.rb +13 -4
- data/lib/aylien_news_api/models/logicals.rb +230 -0
- data/lib/aylien_news_api/models/nested_entity.rb +278 -0
- data/lib/aylien_news_api/models/parameter.rb +701 -0
- data/lib/aylien_news_api/models/query.rb +271 -0
- data/lib/aylien_news_api/models/related_stories.rb +24 -4
- data/lib/aylien_news_api/models/stories.rb +16 -4
- data/lib/aylien_news_api/models/story.rb +14 -4
- data/lib/aylien_news_api/models/time_series.rb +13 -4
- data/lib/aylien_news_api/models/trend.rb +13 -4
- data/lib/aylien_news_api/models/warning.rb +226 -0
- data/lib/aylien_news_api/version.rb +1 -1
- data/spec/api/default_api_spec.rb +145 -0
- data/spec/models/aggregated_sentiment_spec.rb +53 -0
- data/spec/models/entity_links_spec.rb +12 -0
- data/spec/models/entity_sentiment_spec.rb +47 -0
- data/spec/models/entity_spec.rb +26 -2
- data/spec/models/entity_surface_form_spec.rb +53 -0
- data/spec/models/error_links_spec.rb +6 -0
- data/spec/models/logicals_spec.rb +53 -0
- data/spec/models/nested_entity_spec.rb +89 -0
- data/spec/models/parameter_spec.rb +371 -0
- data/spec/models/query_spec.rb +83 -0
- data/spec/models/related_stories_spec.rb +12 -0
- data/spec/models/stories_spec.rb +6 -0
- data/spec/models/story_spec.rb +6 -0
- data/spec/models/time_series_spec.rb +6 -0
- data/spec/models/trend_spec.rb +6 -0
- data/spec/models/warning_spec.rb +53 -0
- metadata +34 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 482268f14a9a7153ba226be5983029146b974cc2677bb28476e256a6b793ffdc
|
|
4
|
+
data.tar.gz: 8f33467bc32d050eb38448683edad84526e056e6c6fa43f77c99293177764c73
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dfa768353ec1d5adc8c1a4a57488587d5deafd0b04af91ee54ee254756017acf2b1a42af661407c976973c7c4c1a7aad0367076a58e09720b4dedb59b4743291
|
|
7
|
+
data.tar.gz: 9e0780f8133814e44302e3c028cee2517b7307574a3a902c38bf630f75372c80efdc596260d00b4d596258cc605aefe49dcb2e45c30dd1f3a6e442213a7f680d
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# AylienNewsApi::AggregatedSentiment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**positive** | **Integer** | Positive sentiments count | [optional]
|
|
8
|
+
**neutral** | **Integer** | Neutral sentiments count | [optional]
|
|
9
|
+
**negative** | **Integer** | Negative sentiments count | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'AylienNewsApi'
|
|
15
|
+
|
|
16
|
+
instance = AylienNewsApi::AggregatedSentiment.new(positive: null,
|
|
17
|
+
neutral: null,
|
|
18
|
+
negative: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/DefaultApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.aylien.com/news*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**advanced_list_stories**](DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
|
|
7
8
|
[**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
|
8
9
|
[**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
|
9
10
|
[**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
|
@@ -15,6 +16,81 @@ Method | HTTP request | Description
|
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
|
|
19
|
+
## advanced_list_stories
|
|
20
|
+
|
|
21
|
+
> Stories advanced_list_stories(unknown_base_type, opts)
|
|
22
|
+
|
|
23
|
+
List Stories
|
|
24
|
+
|
|
25
|
+
The stories endpoint is used to return stories based on the json query you set in your request body. 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, and JSON schema for the body, which you can use to narrow down your query.
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
# load the gem
|
|
31
|
+
require 'aylien_news_api'
|
|
32
|
+
# setup authorization
|
|
33
|
+
AylienNewsApi.configure do |config|
|
|
34
|
+
# Configure API key authorization: app_id
|
|
35
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
37
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
|
38
|
+
|
|
39
|
+
# Configure API key authorization: app_key
|
|
40
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
|
41
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
42
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
api_instance = AylienNewsApi::DefaultApi.new
|
|
46
|
+
unknown_base_type = {"$and":[{"$or":[{"body":{"$text":"Tim Cook"}},{"social.shares.count.reddit.max":{"$gte":5000,"$boost":5}}]},{"entity":{"$and":[{"name":{"$text":"Apple","$boost":2}},{"$not":[{"type":{"$eq":"Fruit"}}]}]}}]} # UNKNOWN_BASE_TYPE | /stories body schema to perform an advanced search with logical operators and nested objects.
|
|
47
|
+
opts = {
|
|
48
|
+
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).
|
|
49
|
+
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).
|
|
50
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
|
51
|
+
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).
|
|
52
|
+
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).
|
|
53
|
+
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).
|
|
54
|
+
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)
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
begin
|
|
58
|
+
#List Stories
|
|
59
|
+
result = api_instance.advanced_list_stories(unknown_base_type, opts)
|
|
60
|
+
p result
|
|
61
|
+
rescue AylienNewsApi::ApiError => e
|
|
62
|
+
puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
Name | Type | Description | Notes
|
|
70
|
+
------------- | ------------- | ------------- | -------------
|
|
71
|
+
**unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| /stories body schema to perform an advanced search with logical operators and nested objects. |
|
|
72
|
+
**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]
|
|
73
|
+
**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]
|
|
74
|
+
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
|
75
|
+
**sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'published_at']
|
|
76
|
+
**sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'desc']
|
|
77
|
+
**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 '*']
|
|
78
|
+
**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]
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
[**Stories**](Stories.md)
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[app_id](../README.md#app_id), [app_key](../README.md#app_key)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: application/json
|
|
91
|
+
- **Accept**: application/json, text/xml
|
|
92
|
+
|
|
93
|
+
|
|
18
94
|
## list_autocompletes
|
|
19
95
|
|
|
20
96
|
> Autocompletes list_autocompletes(type, term, opts)
|
|
@@ -225,18 +301,38 @@ opts = {
|
|
|
225
301
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
226
302
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
227
303
|
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).
|
|
304
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
305
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
306
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
307
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
228
308
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
229
309
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
230
310
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
231
311
|
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).
|
|
312
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
313
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
232
314
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
233
315
|
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).
|
|
316
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
317
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
318
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
319
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
320
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
321
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
322
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
323
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
234
324
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
235
325
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
236
326
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
237
327
|
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).
|
|
328
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
329
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
238
330
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
239
331
|
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).
|
|
332
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
333
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
334
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
335
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
240
336
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
241
337
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
242
338
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -291,6 +387,9 @@ opts = {
|
|
|
291
387
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
|
292
388
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
|
293
389
|
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).
|
|
390
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
391
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
392
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
294
393
|
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
|
295
394
|
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
|
296
395
|
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
|
@@ -333,18 +432,38 @@ Name | Type | Description | Notes
|
|
|
333
432
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
334
433
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
335
434
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
435
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
436
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
437
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
438
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
336
439
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
337
440
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
338
441
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
339
442
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
443
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
444
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
340
445
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
341
446
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
447
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
448
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
449
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
450
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
451
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
452
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
453
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
454
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
342
455
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
343
456
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
344
457
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
345
458
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
459
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
460
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
346
461
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
347
462
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
463
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
464
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
465
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
466
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
348
467
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
349
468
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
350
469
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -399,6 +518,9 @@ Name | Type | Description | Notes
|
|
|
399
518
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
|
400
519
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
|
401
520
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
|
521
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
522
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
523
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
402
524
|
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
|
403
525
|
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
|
404
526
|
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
|
@@ -466,18 +588,38 @@ opts = {
|
|
|
466
588
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
467
589
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
468
590
|
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).
|
|
591
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
592
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
593
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
594
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
469
595
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
470
596
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
471
597
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
472
598
|
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).
|
|
599
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
600
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
473
601
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
474
602
|
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).
|
|
603
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
604
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
605
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
606
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
607
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
608
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
609
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
610
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
475
611
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
476
612
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
477
613
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
478
614
|
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).
|
|
615
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
616
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
479
617
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
480
618
|
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).
|
|
619
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
620
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
621
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
622
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
481
623
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
482
624
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
483
625
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -537,6 +679,9 @@ opts = {
|
|
|
537
679
|
story_url: 'story_url_example', # String | An article or webpage
|
|
538
680
|
story_title: 'story_title_example', # String | Title of the article
|
|
539
681
|
story_body: 'story_body_example', # String | Body of the article
|
|
682
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
683
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
684
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
540
685
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
|
541
686
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
|
542
687
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
|
@@ -577,18 +722,38 @@ Name | Type | Description | Notes
|
|
|
577
722
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
578
723
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
579
724
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
725
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
726
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
727
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
728
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
580
729
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
581
730
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
582
731
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
583
732
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
733
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
734
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
584
735
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
585
736
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
737
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
738
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
739
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
740
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
741
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
742
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
743
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
744
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
586
745
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
587
746
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
588
747
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
589
748
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
749
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
750
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
590
751
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
591
752
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
753
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
754
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
755
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
756
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
592
757
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
593
758
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
594
759
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -648,6 +813,9 @@ Name | Type | Description | Notes
|
|
|
648
813
|
**story_url** | **String**| An article or webpage | [optional]
|
|
649
814
|
**story_title** | **String**| Title of the article | [optional]
|
|
650
815
|
**story_body** | **String**| Body of the article | [optional]
|
|
816
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
817
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
818
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
651
819
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
|
652
820
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
|
653
821
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
|
@@ -714,18 +882,38 @@ opts = {
|
|
|
714
882
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
715
883
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
716
884
|
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).
|
|
885
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
886
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
887
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
888
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
717
889
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
718
890
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
719
891
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
720
892
|
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).
|
|
893
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
894
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
721
895
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
722
896
|
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).
|
|
897
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
898
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
899
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
900
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
901
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
902
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
903
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
904
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
723
905
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
724
906
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
725
907
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
726
908
|
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).
|
|
909
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
910
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
727
911
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
728
912
|
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).
|
|
913
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
914
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
915
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
916
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
729
917
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
730
918
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
731
919
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -785,6 +973,9 @@ opts = {
|
|
|
785
973
|
story_url: 'story_url_example', # String | An article or webpage
|
|
786
974
|
story_title: 'story_title_example', # String | Title of the article
|
|
787
975
|
story_body: 'story_body_example', # String | Body of the article
|
|
976
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
977
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
978
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
788
979
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
|
789
980
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
|
790
981
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
|
@@ -825,18 +1016,38 @@ Name | Type | Description | Notes
|
|
|
825
1016
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
826
1017
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
827
1018
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1019
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1020
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1021
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1022
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
828
1023
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
829
1024
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
830
1025
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
831
1026
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1027
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1028
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
832
1029
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
833
1030
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1031
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1032
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1033
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1034
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1035
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1036
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1037
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1038
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
834
1039
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
835
1040
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
836
1041
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
837
1042
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1043
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1044
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
838
1045
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
839
1046
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1047
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1048
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia 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
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata 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
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
840
1051
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
841
1052
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
842
1053
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -896,6 +1107,9 @@ Name | Type | Description | Notes
|
|
|
896
1107
|
**story_url** | **String**| An article or webpage | [optional]
|
|
897
1108
|
**story_title** | **String**| Title of the article | [optional]
|
|
898
1109
|
**story_body** | **String**| Body of the article | [optional]
|
|
1110
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
1111
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
1112
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
899
1113
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
|
900
1114
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
|
901
1115
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
|
@@ -964,18 +1178,38 @@ opts = {
|
|
|
964
1178
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
965
1179
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
966
1180
|
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).
|
|
1181
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1182
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1183
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1184
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
967
1185
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
968
1186
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
969
1187
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
970
1188
|
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).
|
|
1189
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1190
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
971
1191
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
972
1192
|
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).
|
|
1193
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1194
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1195
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1196
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1197
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1198
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1199
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1200
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
973
1201
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
974
1202
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
975
1203
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
976
1204
|
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).
|
|
1205
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1206
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
977
1207
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
978
1208
|
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).
|
|
1209
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1210
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1211
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1212
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
979
1213
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
980
1214
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
981
1215
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -1031,6 +1265,9 @@ opts = {
|
|
|
1031
1265
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
|
1032
1266
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
|
1033
1267
|
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
|
1268
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
1269
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
1270
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
1034
1271
|
sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
|
1035
1272
|
sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
|
1036
1273
|
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).
|
|
@@ -1073,18 +1310,38 @@ Name | Type | Description | Notes
|
|
|
1073
1310
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1074
1311
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1075
1312
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1313
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1314
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1315
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1316
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1076
1317
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1077
1318
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1078
1319
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1079
1320
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1321
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1322
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1080
1323
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1081
1324
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1325
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1326
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1327
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1328
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1329
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1330
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1331
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1332
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1082
1333
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1083
1334
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1084
1335
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1085
1336
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1337
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1338
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1086
1339
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1087
1340
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1341
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1342
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1343
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1344
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1088
1345
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
1089
1346
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
1090
1347
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -1140,6 +1397,9 @@ Name | Type | Description | Notes
|
|
|
1140
1397
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
|
1141
1398
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
|
1142
1399
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
|
1400
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
1401
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
1402
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
1143
1403
|
**sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'published_at']
|
|
1144
1404
|
**sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'desc']
|
|
1145
1405
|
**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 '*']
|
|
@@ -1205,18 +1465,38 @@ opts = {
|
|
|
1205
1465
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
1206
1466
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
1207
1467
|
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).
|
|
1468
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1469
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1470
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1471
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1208
1472
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1209
1473
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1210
1474
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1211
1475
|
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).
|
|
1476
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1477
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1212
1478
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1213
1479
|
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).
|
|
1480
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1481
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1482
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1483
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1484
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1485
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1486
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1487
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1214
1488
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1215
1489
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1216
1490
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1217
1491
|
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).
|
|
1492
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1493
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1218
1494
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1219
1495
|
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).
|
|
1496
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1497
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1498
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1499
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1220
1500
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
1221
1501
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
1222
1502
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -1271,6 +1551,9 @@ opts = {
|
|
|
1271
1551
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
|
1272
1552
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
|
1273
1553
|
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).
|
|
1554
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
1555
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
1556
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
1274
1557
|
published_at_start: 'NOW-7DAYS/DAY', # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
|
1275
1558
|
published_at_end: 'NOW/DAY', # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
|
1276
1559
|
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).
|
|
@@ -1308,18 +1591,38 @@ Name | Type | Description | Notes
|
|
|
1308
1591
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1309
1592
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1310
1593
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1594
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1595
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1596
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1597
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1311
1598
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1312
1599
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1313
1600
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1314
1601
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1602
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1603
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1315
1604
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1316
1605
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1606
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1607
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1608
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1609
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1610
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1611
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1612
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1613
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1317
1614
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1318
1615
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1319
1616
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1320
1617
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1618
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1619
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1321
1620
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1322
1621
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1622
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1623
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1624
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1625
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1323
1626
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
1324
1627
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
1325
1628
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -1374,6 +1677,9 @@ Name | Type | Description | Notes
|
|
|
1374
1677
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
|
1375
1678
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
|
1376
1679
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
|
1680
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
1681
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
1682
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
1377
1683
|
**published_at_start** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW-7DAYS/DAY']
|
|
1378
1684
|
**published_at_end** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW/DAY']
|
|
1379
1685
|
**period** | **String**| The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to '+1DAY']
|
|
@@ -1443,18 +1749,38 @@ opts = {
|
|
|
1443
1749
|
not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
1444
1750
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
|
1445
1751
|
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).
|
|
1752
|
+
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1753
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1754
|
+
entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1755
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1446
1756
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1447
1757
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1448
1758
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1449
1759
|
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).
|
|
1760
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1761
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1450
1762
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1451
1763
|
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).
|
|
1764
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1765
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1766
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1767
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1768
|
+
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1769
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1770
|
+
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1771
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1452
1772
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1453
1773
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1454
1774
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1455
1775
|
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).
|
|
1776
|
+
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1777
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1456
1778
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1457
1779
|
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).
|
|
1780
|
+
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1781
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1782
|
+
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1783
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
|
1458
1784
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
|
1459
1785
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
|
1460
1786
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
|
@@ -1508,7 +1834,10 @@ opts = {
|
|
|
1508
1834
|
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
|
1509
1835
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
|
1510
1836
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
|
1511
|
-
clusters: ['clusters_example'] # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
|
1837
|
+
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).
|
|
1838
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
|
1839
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
|
1840
|
+
query: 'query_example' # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
|
1512
1841
|
}
|
|
1513
1842
|
|
|
1514
1843
|
begin
|
|
@@ -1548,18 +1877,38 @@ Name | Type | Description | Notes
|
|
|
1548
1877
|
**not_categories_label** | [**Array<String>**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1549
1878
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1550
1879
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
|
1880
|
+
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1881
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1882
|
+
**entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1883
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1551
1884
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1552
1885
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1553
1886
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1554
1887
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1888
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1889
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1555
1890
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1556
1891
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1892
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1893
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1894
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1895
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1896
|
+
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1897
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1898
|
+
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1899
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1557
1900
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1558
1901
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1559
1902
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1560
1903
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1904
|
+
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1905
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1561
1906
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1562
1907
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1908
|
+
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1909
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1910
|
+
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1911
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
|
1563
1912
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
|
1564
1913
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
|
1565
1914
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
|
@@ -1614,6 +1963,9 @@ Name | Type | Description | Notes
|
|
|
1614
1963
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
|
1615
1964
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
|
1616
1965
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
|
1966
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
|
1967
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
|
1968
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
|
1617
1969
|
|
|
1618
1970
|
### Return type
|
|
1619
1971
|
|