Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AdvancedListStoriesOpts
- type AggregatedSentiment
- type Author
- type Autocomplete
- type Autocompletes
- type BasicAuth
- type Category
- type CategoryLinks
- type CategoryTaxonomy
- type Cluster
- type Clusters
- type Configuration
- type Coverages
- type DefaultApiService
- func (a *DefaultApiService) AdvancedListStories(ctx _context.Context, body map[string]interface{}, ...) (DeprecatedStories, *_nethttp.Response, error)
- func (a *DefaultApiService) ListAutocompletes(ctx _context.Context, type_ string, term string, ...) (Autocompletes, *_nethttp.Response, error)
- func (a *DefaultApiService) ListClusters(ctx _context.Context, localVarOptionals *ListClustersOpts) (Clusters, *_nethttp.Response, error)
- func (a *DefaultApiService) ListHistograms(ctx _context.Context, localVarOptionals *ListHistogramsOpts) (Histograms, *_nethttp.Response, error)
- func (a *DefaultApiService) ListRelatedStoriesGet(ctx _context.Context, localVarOptionals *ListRelatedStoriesGetOpts) (DeprecatedRelatedStories, *_nethttp.Response, error)
- func (a *DefaultApiService) ListRelatedStoriesPost(ctx _context.Context, localVarOptionals *ListRelatedStoriesPostOpts) (DeprecatedRelatedStories, *_nethttp.Response, error)
- func (a *DefaultApiService) ListStories(ctx _context.Context, localVarOptionals *ListStoriesOpts) (DeprecatedStories, *_nethttp.Response, error)
- func (a *DefaultApiService) ListTimeSeries(ctx _context.Context, localVarOptionals *ListTimeSeriesOpts) (TimeSeriesList, *_nethttp.Response, error)
- func (a *DefaultApiService) ListTrends(ctx _context.Context, field string, localVarOptionals *ListTrendsOpts) (Trends, *_nethttp.Response, error)
- type DeprecatedEntities
- type DeprecatedEntity
- type DeprecatedEntitySurfaceForm
- type DeprecatedRelatedStories
- type DeprecatedStories
- type DeprecatedStory
- type DunsNumber
- type Entities
- type Entity
- type EntityInText
- type EntityLinks
- type EntityMention
- type EntityMentionIndex
- type EntitySentiment
- type EntitySurfaceForm
- type Error
- type ErrorLinks
- type Errors
- type ExternalIds
- type GenericOpenAPIError
- type HistogramInterval
- type Histograms
- type ListAutocompletesOpts
- type ListClustersOpts
- type ListHistogramsOpts
- type ListRelatedStoriesGetOpts
- type ListRelatedStoriesPostOpts
- type ListStoriesOpts
- type ListTimeSeriesOpts
- type ListTrendsOpts
- type Location
- type Logicals
- type Media
- type MediaFormat
- type MediaType
- type NestedEntity
- type Parameter
- type Query
- type Rank
- type Rankings
- type RelatedStories
- type RepresentativeStory
- type Scope
- type ScopeLevel
- type Sentiment
- type SentimentPolarity
- type Sentiments
- type ServerConfiguration
- type ServerVariable
- type ShareCount
- type ShareCounts
- type Source
- type Stories
- type Story
- type StoryCluster
- type StoryLinks
- type StoryTranslation
- type StoryTranslations
- type StoryTranslationsEn
- type Summary
- type TimeSeries
- type TimeSeriesList
- type Trend
- type Trends
- type Warning
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { DefaultApi *DefaultApiService // contains filtered or unexported fields }
APIClient manages communication with the AYLIEN News API API v4.7.4 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
ChangeBasePath changes base path to allow switching to mocks
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the OpenAPI operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
APIResponse stores the API response returned by the server.
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResonse object.
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
type AdvancedListStoriesOpts ¶ added in v4.7.0
type AdvancedListStoriesOpts struct { PublishedAtStart optional.String PublishedAtEnd optional.String Return_ optional.Interface SortBy optional.String SortDirection optional.String Cursor optional.String PerPage optional.Int32 }
AdvancedListStoriesOpts Optional parameters for the method 'AdvancedListStories'
type AggregatedSentiment ¶ added in v4.7.0
type AggregatedSentiment struct { // Negative sentiments count Negative int32 `json:"negative,omitempty"` // Neutral sentiments count Neutral int32 `json:"neutral,omitempty"` // Positive sentiments count Positive int32 `json:"positive,omitempty"` }
AggregatedSentiment The aggregation of sentiments
type Author ¶
type Author struct { // A URL which points to the author avatar AvatarUrl string `json:"avatar_url,omitempty"` // A unique identification for the author Id int64 `json:"id,omitempty"` // The extracted author full name Name string `json:"name,omitempty"` }
Author struct for Author
type Autocomplete ¶
type Autocomplete struct { // ID of the autocomplete Id string `json:"id,omitempty"` // Text of the autocomplete Text string `json:"text,omitempty"` }
Autocomplete struct for Autocomplete
type Autocompletes ¶
type Autocompletes struct { // An array of autocompletes Autocompletes []Autocomplete `json:"autocompletes,omitempty"` }
Autocompletes struct for Autocompletes
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Category ¶
type Category struct { // It defines whether the extracted category is confident or not Confident *bool `json:"confident,omitempty"` // The ID of the category Id string `json:"id,omitempty"` // The label of the category Label string `json:"label,omitempty"` // The level of the category Level *int32 `json:"level,omitempty"` Links CategoryLinks `json:"links,omitempty"` // The score of the category Score float32 `json:"score,omitempty"` Taxonomy CategoryTaxonomy `json:"taxonomy,omitempty"` }
Category struct for Category
type CategoryLinks ¶
type CategoryLinks struct { // A URL pointing to the parent category Parent *string `json:"parent,omitempty"` // A collection of URLs pointing to the category parents Parents *[]string `json:"parents,omitempty"` // A URL pointing to the category Self string `json:"self,omitempty"` }
CategoryLinks struct for CategoryLinks
type CategoryTaxonomy ¶
type CategoryTaxonomy string
CategoryTaxonomy The taxonomy of the category
const ( IAB_QAG CategoryTaxonomy = "iab-qag" IPTC_SUBJECTCODE CategoryTaxonomy = "iptc-subjectcode" AYLIEN CategoryTaxonomy = "aylien" )
List of CategoryTaxonomy
type Cluster ¶
type Cluster struct { // Publication date of the earliest story in cluster EarliestStory time.Time `json:"earliest_story,omitempty"` // ID of the cluster which is a unique identification Id int64 `json:"id,omitempty"` // Publication date of the latest story in cluster LatestStory time.Time `json:"latest_story,omitempty"` Location Location `json:"location,omitempty"` RepresentativeStory RepresentativeStory `json:"representative_story,omitempty"` // Number of stories associated with the cluster StoryCount int32 `json:"story_count,omitempty"` // Time of the event Time time.Time `json:"time,omitempty"` }
Cluster struct for Cluster
type Clusters ¶
type Clusters struct { // The total number of clusters ClusterCount int64 `json:"cluster_count,omitempty"` // An array of clusters Clusters []Cluster `json:"clusters,omitempty"` // The next page cursor NextPageCursor string `json:"next_page_cursor,omitempty"` }
Clusters struct for Clusters
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` Debug bool `json:"debug,omitempty"` Servers []ServerConfiguration HTTPClient *http.Client }
Configuration stores the configuration of the API client
func NewConfiguration ¶
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration object
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
AddDefaultHeader adds a new HTTP header to the default header in the request
type Coverages ¶
type Coverages struct { // An array of coverages for the input story Coverages []Story `json:"coverages,omitempty"` // The input story body StoryBody string `json:"story_body,omitempty"` // The input story language StoryLanguage string `json:"story_language,omitempty"` // The input story published date StoryPublishedAt time.Time `json:"story_published_at,omitempty"` // The input story title StoryTitle string `json:"story_title,omitempty"` }
Coverages struct for Coverages
type DefaultApiService ¶
type DefaultApiService service
DefaultApiService DefaultApi service
func (*DefaultApiService) AdvancedListStories ¶ added in v4.7.0
func (a *DefaultApiService) AdvancedListStories(ctx _context.Context, body map[string]interface{}, localVarOptionals *AdvancedListStoriesOpts) (DeprecatedStories, *_nethttp.Response, error)
AdvancedListStories List Stories 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.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body /stories body schema to perform an advanced search with logical operators and nested objects.
- @param optional nil or *AdvancedListStoriesOpts - Optional Parameters:
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "Return_" (optional.Interface of []string) - This parameter is used for specifying return fields.
- @param "SortBy" (optional.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).
- @param "SortDirection" (optional.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).
- @param "Cursor" (optional.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).
- @param "PerPage" (optional.Int32) - 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)
@return DeprecatedStories
func (*DefaultApiService) ListAutocompletes ¶
func (a *DefaultApiService) ListAutocompletes(ctx _context.Context, type_ string, term string, localVarOptionals *ListAutocompletesOpts) (Autocompletes, *_nethttp.Response, error)
ListAutocompletes List autocompletes The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below. For example, if you provide the autocompletes endpoint with the term `New York C` and select the type `dbpedia_resources`, the API will return links to the DBpedia resources `New_York_City`, `New_York_City_Subway`, `New_York_City_Police_Department`, and so on.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param type_ This parameter is used for defining the type of autocompletes.
- @param term This parameter is used for finding autocomplete objects that contain the specified value.
- @param optional nil or *ListAutocompletesOpts - Optional Parameters:
- @param "Language" (optional.String) - This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "PerPage" (optional.Int32) - This parameter is used for specifying number of items in each page.
@return Autocompletes
func (*DefaultApiService) ListClusters ¶
func (a *DefaultApiService) ListClusters(ctx _context.Context, localVarOptionals *ListClustersOpts) (Clusters, *_nethttp.Response, error)
ListClusters List Clusters The clusters endpoint is used to return clusters based on parameters you set in your query.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListClustersOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding clusters by cluster id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding clusters by cluster id.
- @param "StoryCountMin" (optional.Int32) - This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them.
- @param "StoryCountMax" (optional.Int32) - This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them.
- @param "TimeStart" (optional.String) - This parameter is used for finding clusters whose creation time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "TimeEnd" (optional.String) - This parameter is used for finding clusters whose creation time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "EarliestStoryStart" (optional.String) - This parameter is used for finding clusters whose publication date of its earliest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "EarliestStoryEnd" (optional.String) - This parameter is used for finding clusters whose publication date of its earliest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "LatestStoryStart" (optional.String) - This parameter is used for finding clusters whose publication date of its latest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "LatestStoryEnd" (optional.String) - This parameter is used for finding clusters whose publication date of its latest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
- @param "LocationCountry" (optional.Interface of []string) - This parameter is used for finding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotLocationCountry" (optional.Interface of []string) - This parameter is used for excluding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "Return_" (optional.Interface of []string) - This parameter is used for specifying return fields.
- @param "SortBy" (optional.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).
- @param "SortDirection" (optional.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).
- @param "Cursor" (optional.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).
- @param "PerPage" (optional.Int32) - 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)
@return Clusters
func (*DefaultApiService) ListHistograms ¶
func (a *DefaultApiService) ListHistograms(ctx _context.Context, localVarOptionals *ListHistogramsOpts) (Histograms, *_nethttp.Response, error)
ListHistograms List histograms For the numerical metadata that the News API gathers (such as word counts or social shares for example), you can use the histograms endpoint to access and display this information. As this endpoint does not return actual stories, the results you are given will not count towards your story allowance provided by your subscription, so you can effectively query this endpoint free of charge.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListHistogramsOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "LinksPermalink" (optional.Interface of []string) - This parameter is used to find stories based on their url.
- @param "NotLinksPermalink" (optional.Interface of []string) - This parameter is used to exclude stories based on their url.
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
- @param "IntervalStart" (optional.Int32) - This parameter is used for setting the start data point of histogram intervals.
- @param "IntervalEnd" (optional.Int32) - This parameter is used for setting the end data point of histogram intervals.
- @param "IntervalWidth" (optional.Int32) - This parameter is used for setting the width of histogram intervals.
- @param "Field" (optional.String) - This parameter is used for specifying the y-axis variable for the histogram.
@return Histograms
func (*DefaultApiService) ListRelatedStoriesGet ¶
func (a *DefaultApiService) ListRelatedStoriesGet(ctx _context.Context, localVarOptionals *ListRelatedStoriesGetOpts) (DeprecatedRelatedStories, *_nethttp.Response, error)
ListRelatedStoriesGet Method for ListRelatedStoriesGet
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListRelatedStoriesGetOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "LinksPermalink" (optional.Interface of []string) - This parameter is used to find stories based on their url.
- @param "NotLinksPermalink" (optional.Interface of []string) - This parameter is used to exclude stories based on their url.
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Return_" (optional.Interface of []string) - This parameter is used for specifying return fields.
- @param "StoryId" (optional.Int64) - A story id
- @param "StoryUrl" (optional.String) - An article or webpage
- @param "StoryTitle" (optional.String) - Title of the article
- @param "StoryBody" (optional.String) - Body of the article
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
- @param "BoostBy" (optional.String) - This parameter is used for boosting the result by the specified value.
- @param "StoryLanguage" (optional.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.
- @param "PerPage" (optional.Int32) - This parameter is used for specifying number of items in each page.
@return DeprecatedRelatedStories
func (*DefaultApiService) ListRelatedStoriesPost ¶
func (a *DefaultApiService) ListRelatedStoriesPost(ctx _context.Context, localVarOptionals *ListRelatedStoriesPostOpts) (DeprecatedRelatedStories, *_nethttp.Response, error)
ListRelatedStoriesPost Method for ListRelatedStoriesPost
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListRelatedStoriesPostOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "LinksPermalink" (optional.Interface of []string) - This parameter is used to find stories based on their url.
- @param "NotLinksPermalink" (optional.Interface of []string) - This parameter is used to exclude stories based on their url.
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Return_" (optional.Interface of []string) - This parameter is used for specifying return fields.
- @param "StoryId" (optional.Int64) - A story id
- @param "StoryUrl" (optional.String) - An article or webpage
- @param "StoryTitle" (optional.String) - Title of the article
- @param "StoryBody" (optional.String) - Body of the article
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
- @param "BoostBy" (optional.String) - This parameter is used for boosting the result by the specified value.
- @param "StoryLanguage" (optional.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.
- @param "PerPage" (optional.Int32) - This parameter is used for specifying number of items in each page.
@return DeprecatedRelatedStories
func (*DefaultApiService) ListStories ¶
func (a *DefaultApiService) ListStories(ctx _context.Context, localVarOptionals *ListStoriesOpts) (DeprecatedStories, *_nethttp.Response, error)
ListStories List Stories The stories endpoint is used to return stories based on parameters you set in your query. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, which you can use to narrow down your query.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListStoriesOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "LinksPermalink" (optional.Interface of []string) - This parameter is used to find stories based on their url.
- @param "NotLinksPermalink" (optional.Interface of []string) - This parameter is used to exclude stories based on their url.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Return_" (optional.Interface of []string) - This parameter is used for specifying return fields.
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
- @param "SortBy" (optional.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).
- @param "SortDirection" (optional.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).
- @param "Cursor" (optional.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).
- @param "PerPage" (optional.Int32) - 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)
@return DeprecatedStories
func (*DefaultApiService) ListTimeSeries ¶
func (a *DefaultApiService) ListTimeSeries(ctx _context.Context, localVarOptionals *ListTimeSeriesOpts) (TimeSeriesList, *_nethttp.Response, error)
ListTimeSeries List time series The time series endpoint allows you to track information contained in stories over time. This information can be anything from mentions of a topic or entities, sentiment about a topic, or the volume of stories published by a source, to name but a few. The full list of parameters is given below. Using the [Date Math Syntax](https://newsapi.aylien.com/docs/working-with-dates), you can easily set your query to return information from any time period, from the current point in time to when the News API started collecting stories. The returned information can be rounded to a time also specified by you, for example by setting the results into hourly, daily, or weekly data points.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListTimeSeriesOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "Period" (optional.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).
@return TimeSeriesList
func (*DefaultApiService) ListTrends ¶
func (a *DefaultApiService) ListTrends(ctx _context.Context, field string, localVarOptionals *ListTrendsOpts) (Trends, *_nethttp.Response, error)
ListTrends List trends The trends endpoint allows you to identify the most-mentioned entities, concepts and keywords relevant to your query. For example, this endpoint allows you to set parameters like a time period, a subject category, or an entity, and your request will return the most mentioned entities or keywords that are mentioned in relation to your query.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param field This parameter is used to specify the trend field.
- @param optional nil or *ListTrendsOpts - Optional Parameters:
- @param "Id" (optional.Interface of []int64) - This parameter is used for finding stories by story id.
- @param "NotId" (optional.Interface of []int64) - This parameter is used for excluding stories by story id.
- @param "Title" (optional.String) - This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Body" (optional.String) - This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "Text" (optional.String) - This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnTitle" (optional.String) - This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnBody" (optional.String) - This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "TranslationsEnText" (optional.String) - This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
- @param "LinksPermalink" (optional.Interface of []string) - This parameter is used to find stories based on their url.
- @param "NotLinksPermalink" (optional.Interface of []string) - This parameter is used to exclude stories based on their url.
- @param "Language" (optional.Interface of []string) - This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "NotLanguage" (optional.Interface of []string) - This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
- @param "PublishedAtStart" (optional.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).
- @param "PublishedAtEnd" (optional.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).
- @param "CategoriesTaxonomy" (optional.String) - This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesConfident" (optional.Bool) - This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesId" (optional.Interface of []string) - This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesId" (optional.Interface of []string) - This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "CategoriesLabel" (optional.Interface of []string) - This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
- @param "NotCategoriesLabel" (optional.Interface of []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).
- @param "CategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "NotCategoriesLevel" (optional.Interface of []Int32) - 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).
- @param "EntitiesTitleId" (optional.Interface of []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).
- @param "NotEntitiesTitleId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleSurfaceFormsText" (optional.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).
- @param "NotEntitiesTitleSurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleText" (optional.Interface of []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).
- @param "NotEntitiesTitleText" (optional.Interface of []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).
- @param "EntitiesTitleType" (optional.Interface of []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).
- @param "NotEntitiesTitleType" (optional.Interface of []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).
- @param "EntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesTitleLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "NotEntitiesTitleLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyId" (optional.Interface of []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).
- @param "NotEntitiesBodyId" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodySurfaceFormsText" (optional.Interface of []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).
- @param "NotEntitiesBodySurfaceFormsText" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyText" (optional.Interface of []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).
- @param "NotEntitiesBodyText" (optional.Interface of []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).
- @param "EntitiesBodyType" (optional.Interface of []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).
- @param "NotEntitiesBodyType" (optional.Interface of []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).
- @param "EntitiesBodyStockTicker" (optional.Interface of []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).
- @param "NotEntitiesBodyStockTicker" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksDbpedia" (optional.Interface of []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).
- @param "EntitiesBodyLinksWikipedia" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikipedia" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "EntitiesBodyLinksWikidata" (optional.Interface of []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).
- @param "NotEntitiesBodyLinksWikidata" (optional.Interface of []string) - This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
- @param "SentimentTitlePolarity" (optional.String) - This parameter is used for finding stories whose title sentiment is the specified value.
- @param "NotSentimentTitlePolarity" (optional.String) - This parameter is used for excluding stories whose title sentiment is the specified value.
- @param "SentimentBodyPolarity" (optional.String) - This parameter is used for finding stories whose body sentiment is the specified value.
- @param "NotSentimentBodyPolarity" (optional.String) - This parameter is used for excluding stories whose body sentiment is the specified value.
- @param "MediaImagesCountMin" (optional.Int32) - This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
- @param "MediaImagesCountMax" (optional.Int32) - This parameter is used for finding stories whose number of images is less than or equal to the specified value.
- @param "MediaImagesWidthMin" (optional.Int32) - This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
- @param "MediaImagesWidthMax" (optional.Int32) - This parameter is used for finding stories whose width of images are less than or equal to the specified value.
- @param "MediaImagesHeightMin" (optional.Int32) - This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
- @param "MediaImagesHeightMax" (optional.Int32) - This parameter is used for finding stories whose height of images are less than or equal to the specified value.
- @param "MediaImagesContentLengthMin" (optional.Int32) - This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
- @param "MediaImagesContentLengthMax" (optional.Int32) - This parameter is used for finding stories whose images content length are less than or equal to the specified value.
- @param "MediaImagesFormat" (optional.Interface of []string) - This parameter is used for finding stories whose images format are the specified value.
- @param "NotMediaImagesFormat" (optional.Interface of []string) - This parameter is used for excluding stories whose images format are the specified value.
- @param "MediaVideosCountMin" (optional.Int32) - This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
- @param "MediaVideosCountMax" (optional.Int32) - This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
- @param "AuthorId" (optional.Interface of []Int32) - This parameter is used for finding stories whose author id is the specified value.
- @param "NotAuthorId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose author id is the specified value.
- @param "AuthorName" (optional.String) - This parameter is used for finding stories whose author full name contains the specified value.
- @param "NotAuthorName" (optional.String) - This parameter is used for excluding stories whose author full name contains the specified value.
- @param "SourceId" (optional.Interface of []Int32) - This parameter is used for finding stories whose source id is the specified value.
- @param "NotSourceId" (optional.Interface of []Int32) - This parameter is used for excluding stories whose source id is the specified value.
- @param "SourceName" (optional.Interface of []string) - This parameter is used for finding stories whose source name contains the specified value.
- @param "NotSourceName" (optional.Interface of []string) - This parameter is used for excluding stories whose source name contains the specified value.
- @param "SourceDomain" (optional.Interface of []string) - This parameter is used for finding stories whose source domain is the specified value.
- @param "NotSourceDomain" (optional.Interface of []string) - This parameter is used for excluding stories whose source domain is the specified value.
- @param "SourceLocationsCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsState" (optional.Interface of []string) - This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsState" (optional.Interface of []string) - This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLocationsCity" (optional.Interface of []string) - This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceLocationsCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCountry" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCountry" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesState" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesState" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesCity" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesCity" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceScopesLevel" (optional.Interface of []string) - This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "NotSourceScopesLevel" (optional.Interface of []string) - This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
- @param "SourceLinksInCountMin" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceLinksInCountMax" (optional.Int32) - This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
- @param "SourceRankingsAlexaRankMin" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaRankMax" (optional.Int32) - This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SourceRankingsAlexaCountry" (optional.Interface of []string) - This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
- @param "SocialSharesCountFacebookMin" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountFacebookMax" (optional.Int32) - This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMin" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountGooglePlusMax" (optional.Int32) - This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
- @param "SocialSharesCountLinkedinMin" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountLinkedinMax" (optional.Int32) - This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
- @param "SocialSharesCountRedditMin" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
- @param "SocialSharesCountRedditMax" (optional.Int32) - This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
- @param "Clusters" (optional.Interface of []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).
- @param "Aql" (optional.String) - This parameter is used to supply a query in AYLIEN Query Language.
- @param "AqlDefaultField" (optional.String) - This parameter is used to supply an optional default field name used in the AQL query.
- @param "Query" (optional.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.
@return Trends
type DeprecatedEntities ¶ added in v4.7.0
type DeprecatedEntities struct { // An array of extracted entities from the story body Body []DeprecatedEntity `json:"body,omitempty"` // An array of extracted entities from the story title Title []DeprecatedEntity `json:"title,omitempty"` }
DeprecatedEntities struct for DeprecatedEntities
type DeprecatedEntity ¶ added in v4.7.0
type DeprecatedEntity struct { // The unique ID of the entity Id string `json:"id,omitempty"` // The indices of the entity text Indices [][]int32 `json:"indices,omitempty"` Links EntityLinks `json:"links,omitempty"` // Describes how relevant an entity is to the article ProminenceScore float32 `json:"prominence_score,omitempty"` Sentiment EntitySentiment `json:"sentiment,omitempty"` // The stock_ticker of the entity (might be null) StockTicker string `json:"stock_ticker,omitempty"` SurfaceForms []DeprecatedEntitySurfaceForm `json:"surface_forms,omitempty"` // The entity text Text string `json:"text,omitempty"` // An array of the entity types Types []string `json:"types,omitempty"` }
DeprecatedEntity struct for DeprecatedEntity
type DeprecatedEntitySurfaceForm ¶ added in v4.7.0
type DeprecatedEntitySurfaceForm struct { // Amount of entity surface form mentions in the article Frequency int32 `json:"frequency,omitempty"` // The indices of the entity text Indices [][]int32 `json:"indices,omitempty"` // The entity text Text string `json:"text,omitempty"` }
DeprecatedEntitySurfaceForm struct for DeprecatedEntitySurfaceForm
type DeprecatedRelatedStories ¶ added in v4.7.0
type DeprecatedRelatedStories struct { // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` // An array of related stories for the input story RelatedStories []DeprecatedStory `json:"related_stories,omitempty"` // The input story body StoryBody string `json:"story_body,omitempty"` // The input story language StoryLanguage string `json:"story_language,omitempty"` // The input story title StoryTitle string `json:"story_title,omitempty"` }
DeprecatedRelatedStories Story with deprecated entities
type DeprecatedStories ¶ added in v4.7.0
type DeprecatedStories struct { // The next page cursor NextPageCursor string `json:"next_page_cursor,omitempty"` // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` // An array of stories Stories []DeprecatedStory `json:"stories,omitempty"` // Notifies about possible issues that occurred when searching for stories Warnings []Warning `json:"warnings,omitempty"` }
DeprecatedStories Stories containing deprecated entities
type DeprecatedStory ¶ added in v4.7.0
type DeprecatedStory struct { Author Author `json:"author,omitempty"` // Body of the story Body string `json:"body,omitempty"` // Suggested categories for the story Categories []Category `json:"categories,omitempty"` // Character count of the story body CharactersCount int32 `json:"characters_count,omitempty"` // An array of clusters the story is associated with Clusters []int64 `json:"clusters,omitempty"` Entities DeprecatedEntities `json:"entities,omitempty"` Hashtags []string `json:"hashtags,omitempty"` // ID of the story which is a unique identification Id int64 `json:"id,omitempty"` // An array of industries categories Industries []Category `json:"industries,omitempty"` // Extracted keywords mentioned in the story title or body Keywords []string `json:"keywords,omitempty"` // Language of the story Language string `json:"language,omitempty"` // License type of the story LicenseType int32 `json:"license_type,omitempty"` Links StoryLinks `json:"links,omitempty"` // An array of extracted media such as images and videos Media []Media `json:"media,omitempty"` // Paragraph count of the story body ParagraphsCount int32 `json:"paragraphs_count,omitempty"` // Acquisition time of the story PublishedAt time.Time `json:"published_at,omitempty"` // Publication time of the story, if available, otherwise time of acquisition PublishedDatetime time.Time `json:"published_datetime,omitempty"` // Sentence count of the story body SentencesCount int32 `json:"sentences_count,omitempty"` Sentiment Sentiments `json:"sentiment,omitempty"` Source Source `json:"source,omitempty"` Summary Summary `json:"summary,omitempty"` // Title of the story Title string `json:"title,omitempty"` Translations StoryTranslations `json:"translations,omitempty"` // Word count of the story body WordsCount int32 `json:"words_count,omitempty"` }
DeprecatedStory struct for DeprecatedStory
type DunsNumber ¶ added in v4.7.2
type DunsNumber struct {
Id string `json:"id,omitempty"`
}
DunsNumber struct for DunsNumber
type Entities ¶
type Entities struct { // An array of extracted entities from the story body Body []Entity `json:"body,omitempty"` // An array of extracted entities from the story title Title []Entity `json:"title,omitempty"` }
Entities struct for Entities
type Entity ¶
type Entity struct { Body EntityInText `json:"body,omitempty"` // The unique ID of the entity Id string `json:"id,omitempty"` Links EntityLinks `json:"links,omitempty"` // Amount of entity surface form mentions in the article OverallFrequency int32 `json:"overall_frequency,omitempty"` // Describes how relevant an entity is to the article OverallProminence float32 `json:"overall_prominence,omitempty"` OverallSentiment EntitySentiment `json:"overall_sentiment,omitempty"` // The stock tickers of the entity (might be empty) StockTickers []string `json:"stock_tickers,omitempty"` Title EntityInText `json:"title,omitempty"` // An array of the entity types Types []string `json:"types,omitempty"` }
Entity struct for Entity
type EntityInText ¶ added in v4.7.0
type EntityInText struct { Sentiment EntitySentiment `json:"sentiment,omitempty"` SurfaceForms []EntitySurfaceForm `json:"surface_forms,omitempty"` }
EntityInText struct for EntityInText
type EntityLinks ¶
type EntityLinks struct { // A dbpedia resource URL (deprecated) Dbpedia string `json:"dbpedia,omitempty"` // A wikidata resource URL Wikidata string `json:"wikidata,omitempty"` // A wikipedia resource URL Wikipedia string `json:"wikipedia,omitempty"` }
EntityLinks struct for EntityLinks
type EntityMention ¶ added in v4.7.0
type EntityMention struct { Index EntityMentionIndex `json:"index,omitempty"` Sentiment EntitySentiment `json:"sentiment,omitempty"` }
EntityMention struct for EntityMention
type EntityMentionIndex ¶ added in v4.7.0
type EntityMentionIndex struct { // End index of a single entity mention in the text (counting from 0) End int32 `json:"end"` // Start index of a single entity mention in the text (counting from 0) Start int32 `json:"start"` }
EntityMentionIndex struct for EntityMentionIndex
type EntitySentiment ¶ added in v4.7.0
type EntitySentiment struct { // Polarity confidence of the sentiment Confidence float64 `json:"confidence,omitempty"` Polarity SentimentPolarity `json:"polarity,omitempty"` }
EntitySentiment struct for EntitySentiment
type EntitySurfaceForm ¶ added in v4.7.0
type EntitySurfaceForm struct { // Amount of entity surface form mentions in the article Frequency int32 `json:"frequency,omitempty"` // Mentions of the entity text Mentions []EntityMention `json:"mentions,omitempty"` // The entity text Text string `json:"text,omitempty"` }
EntitySurfaceForm struct for EntitySurfaceForm
type Error ¶
type Error struct { Code string `json:"code,omitempty"` Detail string `json:"detail,omitempty"` Id string `json:"id,omitempty"` Links ErrorLinks `json:"links,omitempty"` Status float32 `json:"status,omitempty"` Title string `json:"title,omitempty"` }
Error struct for Error
type ErrorLinks ¶
type ErrorLinks struct { About string `json:"about,omitempty"` Docs string `json:"docs,omitempty"` }
ErrorLinks struct for ErrorLinks
type Errors ¶
type Errors struct {
Errors []Error `json:"errors,omitempty"`
}
Errors struct for Errors
type ExternalIds ¶ added in v4.7.2
type ExternalIds struct { // DUNS number(s) of the entity Duns []DunsNumber `json:"duns,omitempty"` }
ExternalIds External Ids of an entity
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
func (GenericOpenAPIError) Body ¶
func (e GenericOpenAPIError) Body() []byte
Body returns the raw bytes of the response
func (GenericOpenAPIError) Error ¶
func (e GenericOpenAPIError) Error() string
Error returns non-empty string if there was an error.
func (GenericOpenAPIError) Model ¶
func (e GenericOpenAPIError) Model() interface{}
Model returns the unpacked model of the error
type HistogramInterval ¶
type HistogramInterval struct { // Histogram bin Bin int32 `json:"bin,omitempty"` // Histogram bin size Count int32 `json:"count,omitempty"` }
HistogramInterval struct for HistogramInterval
type Histograms ¶
type Histograms struct { Field string `json:"field,omitempty"` // The end interval of the histogram IntervalEnd int32 `json:"interval.end,omitempty"` // The start interval of the histogram IntervalStart int32 `json:"interval.start,omitempty"` // The width of the histogram IntervalWidth int32 `json:"interval.width,omitempty"` // The intervals of the histograms Intervals []HistogramInterval `json:"intervals,omitempty"` // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` }
Histograms struct for Histograms
type ListAutocompletesOpts ¶
ListAutocompletesOpts Optional parameters for the method 'ListAutocompletes'
type ListClustersOpts ¶
type ListClustersOpts struct { Id optional.Interface NotId optional.Interface StoryCountMin optional.Int32 StoryCountMax optional.Int32 TimeStart optional.String TimeEnd optional.String EarliestStoryStart optional.String EarliestStoryEnd optional.String LatestStoryStart optional.String LatestStoryEnd optional.String LocationCountry optional.Interface NotLocationCountry optional.Interface Return_ optional.Interface SortBy optional.String SortDirection optional.String Cursor optional.String PerPage optional.Int32 }
ListClustersOpts Optional parameters for the method 'ListClusters'
type ListHistogramsOpts ¶
type ListHistogramsOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String LinksPermalink optional.Interface NotLinksPermalink optional.Interface Language optional.Interface NotLanguage optional.Interface PublishedAtStart optional.String PublishedAtEnd optional.String CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Aql optional.String AqlDefaultField optional.String Query optional.String IntervalStart optional.Int32 IntervalEnd optional.Int32 IntervalWidth optional.Int32 Field optional.String }
ListHistogramsOpts Optional parameters for the method 'ListHistograms'
type ListRelatedStoriesGetOpts ¶
type ListRelatedStoriesGetOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String LinksPermalink optional.Interface NotLinksPermalink optional.Interface Language optional.Interface NotLanguage optional.Interface PublishedAtStart optional.String PublishedAtEnd optional.String CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Return_ optional.Interface StoryId optional.Int64 StoryUrl optional.String StoryTitle optional.String StoryBody optional.String Aql optional.String AqlDefaultField optional.String Query optional.String BoostBy optional.String StoryLanguage optional.String PerPage optional.Int32 }
ListRelatedStoriesGetOpts Optional parameters for the method 'ListRelatedStoriesGet'
type ListRelatedStoriesPostOpts ¶
type ListRelatedStoriesPostOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String LinksPermalink optional.Interface NotLinksPermalink optional.Interface Language optional.Interface NotLanguage optional.Interface PublishedAtStart optional.String PublishedAtEnd optional.String CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Return_ optional.Interface StoryId optional.Int64 StoryUrl optional.String StoryTitle optional.String StoryBody optional.String Aql optional.String AqlDefaultField optional.String Query optional.String BoostBy optional.String StoryLanguage optional.String PerPage optional.Int32 }
ListRelatedStoriesPostOpts Optional parameters for the method 'ListRelatedStoriesPost'
type ListStoriesOpts ¶
type ListStoriesOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String Language optional.Interface NotLanguage optional.Interface LinksPermalink optional.Interface NotLinksPermalink optional.Interface PublishedAtStart optional.String PublishedAtEnd optional.String CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Return_ optional.Interface Aql optional.String AqlDefaultField optional.String Query optional.String SortBy optional.String SortDirection optional.String Cursor optional.String PerPage optional.Int32 }
ListStoriesOpts Optional parameters for the method 'ListStories'
type ListTimeSeriesOpts ¶
type ListTimeSeriesOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String Language optional.Interface NotLanguage optional.Interface CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Aql optional.String AqlDefaultField optional.String Query optional.String PublishedAtStart optional.String PublishedAtEnd optional.String Period optional.String }
ListTimeSeriesOpts Optional parameters for the method 'ListTimeSeries'
type ListTrendsOpts ¶
type ListTrendsOpts struct { Id optional.Interface NotId optional.Interface Title optional.String Body optional.String Text optional.String TranslationsEnTitle optional.String TranslationsEnBody optional.String TranslationsEnText optional.String LinksPermalink optional.Interface NotLinksPermalink optional.Interface Language optional.Interface NotLanguage optional.Interface PublishedAtStart optional.String PublishedAtEnd optional.String CategoriesTaxonomy optional.String CategoriesConfident optional.Bool CategoriesId optional.Interface NotCategoriesId optional.Interface CategoriesLabel optional.Interface NotCategoriesLabel optional.Interface CategoriesLevel optional.Interface NotCategoriesLevel optional.Interface EntitiesTitleId optional.Interface NotEntitiesTitleId optional.Interface EntitiesTitleSurfaceFormsText optional.String NotEntitiesTitleSurfaceFormsText optional.Interface EntitiesTitleText optional.Interface NotEntitiesTitleText optional.Interface EntitiesTitleType optional.Interface NotEntitiesTitleType optional.Interface EntitiesTitleStockTicker optional.Interface NotEntitiesTitleStockTicker optional.Interface EntitiesTitleLinksDbpedia optional.Interface NotEntitiesTitleLinksDbpedia optional.Interface EntitiesTitleLinksWikipedia optional.Interface NotEntitiesTitleLinksWikipedia optional.Interface EntitiesTitleLinksWikidata optional.Interface NotEntitiesTitleLinksWikidata optional.Interface EntitiesBodyId optional.Interface NotEntitiesBodyId optional.Interface EntitiesBodySurfaceFormsText optional.Interface NotEntitiesBodySurfaceFormsText optional.Interface EntitiesBodyText optional.Interface NotEntitiesBodyText optional.Interface EntitiesBodyType optional.Interface NotEntitiesBodyType optional.Interface EntitiesBodyStockTicker optional.Interface NotEntitiesBodyStockTicker optional.Interface EntitiesBodyLinksDbpedia optional.Interface NotEntitiesBodyLinksDbpedia optional.Interface EntitiesBodyLinksWikipedia optional.Interface NotEntitiesBodyLinksWikipedia optional.Interface EntitiesBodyLinksWikidata optional.Interface NotEntitiesBodyLinksWikidata optional.Interface SentimentTitlePolarity optional.String NotSentimentTitlePolarity optional.String SentimentBodyPolarity optional.String NotSentimentBodyPolarity optional.String MediaImagesCountMin optional.Int32 MediaImagesCountMax optional.Int32 MediaImagesWidthMin optional.Int32 MediaImagesWidthMax optional.Int32 MediaImagesHeightMin optional.Int32 MediaImagesHeightMax optional.Int32 MediaImagesContentLengthMin optional.Int32 MediaImagesContentLengthMax optional.Int32 MediaImagesFormat optional.Interface NotMediaImagesFormat optional.Interface MediaVideosCountMin optional.Int32 MediaVideosCountMax optional.Int32 AuthorId optional.Interface NotAuthorId optional.Interface AuthorName optional.String NotAuthorName optional.String SourceId optional.Interface NotSourceId optional.Interface SourceName optional.Interface NotSourceName optional.Interface SourceDomain optional.Interface NotSourceDomain optional.Interface SourceLocationsCountry optional.Interface NotSourceLocationsCountry optional.Interface SourceLocationsState optional.Interface NotSourceLocationsState optional.Interface SourceLocationsCity optional.Interface NotSourceLocationsCity optional.Interface SourceScopesCountry optional.Interface NotSourceScopesCountry optional.Interface SourceScopesState optional.Interface NotSourceScopesState optional.Interface SourceScopesCity optional.Interface NotSourceScopesCity optional.Interface SourceScopesLevel optional.Interface NotSourceScopesLevel optional.Interface SourceLinksInCountMin optional.Int32 SourceLinksInCountMax optional.Int32 SourceRankingsAlexaRankMin optional.Int32 SourceRankingsAlexaRankMax optional.Int32 SourceRankingsAlexaCountry optional.Interface Clusters optional.Interface Aql optional.String AqlDefaultField optional.String Query optional.String }
ListTrendsOpts Optional parameters for the method 'ListTrends'
type Location ¶
type Location struct { // The city of the location City string `json:"city,omitempty"` // The country code of the location. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. Country string `json:"country,omitempty"` // The state of the location State string `json:"state,omitempty"` }
Location struct for Location
type Logicals ¶ added in v4.7.2
type Logicals struct { And []AnyOfLogicalsParameter `json:"$and,omitempty"` Or []AnyOfLogicalsParameter `json:"$or,omitempty"` Not []AnyOfLogicalsParameter `json:"$not,omitempty"` }
Logicals struct for Logicals
type Media ¶
type Media struct { // The content length of media ContentLength int32 `json:"content_length,omitempty"` Format MediaFormat `json:"format,omitempty"` // The height of media Height int32 `json:"height,omitempty"` Type MediaType `json:"type,omitempty"` // A URL which points to the media file Url string `json:"url,omitempty"` // The width of media Width int32 `json:"width,omitempty"` }
Media struct for Media
type MediaFormat ¶
type MediaFormat string
MediaFormat The format of media
const ( BMP MediaFormat = "BMP" GIF MediaFormat = "GIF" JPEG MediaFormat = "JPEG" PNG MediaFormat = "PNG" TIFF MediaFormat = "TIFF" PSD MediaFormat = "PSD" ICO MediaFormat = "ICO" CUR MediaFormat = "CUR" WEBP MediaFormat = "WEBP" SVG MediaFormat = "SVG" )
List of MediaFormat
type NestedEntity ¶ added in v4.7.2
type NestedEntity struct { Id Query `json:"id,omitempty"` Name Query `json:"name,omitempty"` SurfaceFormsText Query `json:"surface_forms.text,omitempty"` Sentiment Query `json:"sentiment,omitempty"` Element Query `json:"element,omitempty"` LinksWikipedia Query `json:"links.wikipedia,omitempty"` LinksWikidata Query `json:"links.wikidata,omitempty"` StockTicker Query `json:"stock_ticker,omitempty"` Type Query `json:"type,omitempty"` }
NestedEntity struct for NestedEntity
type Parameter ¶ added in v4.7.2
type Parameter struct { AuthorId Query `json:"author.id,omitempty"` AuthorName Query `json:"author.name,omitempty"` Body Query `json:"body,omitempty"` CategoriesConfident Query `json:"categories.confident,omitempty"` CategoriesId Query `json:"categories.id,omitempty"` CategoriesLevel Query `json:"categories.level,omitempty"` CategoriesTaxonomy Query `json:"categories.taxonomy,omitempty"` Clusters Query `json:"clusters,omitempty"` LinksPermalink Query `json:"links.permalink,omitempty"` EntitiesId Query `json:"entities.id,omitempty"` EntitiesSurfaceFormsText Query `json:"entities.surface_forms.text,omitempty"` EntitiesLinksWikipedia Query `json:"entities.links.wikipedia,omitempty"` EntitiesLinksWikidata Query `json:"entities.links.wikidata,omitempty"` EntitiesTitleSurfaceFormsText Query `json:"entities.title.surface_forms.text,omitempty"` EntitiesBodySurfaceFormsText Query `json:"entities.body.surface_forms.text,omitempty"` Id Query `json:"id,omitempty"` Language Query `json:"language,omitempty"` MediaImagesContentLengthMax Query `json:"media.images.content.length.max,omitempty"` MediaImagesContentLengthMin Query `json:"media.images.content.length.min,omitempty"` MediaImagesCountMax Query `json:"media.images.count.max,omitempty"` MediaImagesCountMin Query `json:"media.images.count.min,omitempty"` MediaImagesFormat Query `json:"media.images.format,omitempty"` MediaImagesHeightMax Query `json:"media.images.height.max,omitempty"` MediaImagesHeightMin Query `json:"media.images.height.min,omitempty"` MediaImagesWidthMax Query `json:"media.images.width.max,omitempty"` MediaImagesWidthMin Query `json:"media.images.width.min,omitempty"` MediaVideosCountMax Query `json:"media.videos.count.max,omitempty"` MediaVideosCountMin Query `json:"media.videos.count.min,omitempty"` SentimentBodyPolarity Query `json:"sentiment.body.polarity,omitempty"` SentimentTitlePolarity Query `json:"sentiment.title.polarity,omitempty"` SourceDomain Query `json:"source.domain,omitempty"` SourceId Query `json:"source.id,omitempty"` SourceLinksInCountMax Query `json:"source.links.in.count.max,omitempty"` SourceLinksInCountMin Query `json:"source.links.in.count.min,omitempty"` SourceLocationsCity Query `json:"source.locations.city,omitempty"` SourceLocationsCountry Query `json:"source.locations.country,omitempty"` SourceLocationsState Query `json:"source.locations.state,omitempty"` SourceRankingsAlexaCountry Query `json:"source.rankings.alexa.country,omitempty"` SourceRankingsAlexaRankMax Query `json:"source.rankings.alexa.rank.max,omitempty"` SourceRankingsAlexaRankMin Query `json:"source.rankings.alexa.rank.min,omitempty"` SourceScopesCity Query `json:"source.scopes.city,omitempty"` SourceScopesCountry Query `json:"source.scopes.country,omitempty"` SourceScopesLevel Query `json:"source.scopes.level,omitempty"` SourceScopesState Query `json:"source.scopes.state,omitempty"` StoryUrl Query `json:"story_url,omitempty"` StoryLanguage Query `json:"story_language,omitempty"` Text Query `json:"text,omitempty"` Title Query `json:"title,omitempty"` TranslationsEnBody Query `json:"translations.en.body,omitempty"` TranslationsEnText Query `json:"translations.en.text,omitempty"` TranslationsEnTitle Query `json:"translations.en.title,omitempty"` Entity OneOfNestedEntityLogicals `json:"entity,omitempty"` }
Parameter struct for Parameter
type Query ¶ added in v4.7.2
type Query struct { Eq OneOfstringnumber `json:"$eq,omitempty"` Text OneOfstringnumber `json:"$text,omitempty"` In []OneOfstringnumber `json:"$in,omitempty"` Gt float32 `json:"$gt,omitempty"` Gte float32 `json:"$gte,omitempty"` Lt float32 `json:"$lt,omitempty"` Lte float32 `json:"$lte,omitempty"` Boost float32 `json:"$boost,omitempty"` }
Query struct for Query
type Rank ¶
type Rank struct { // The country code which the rank is in it Country string `json:"country,omitempty"` // The fetched date of the rank FetchedAt time.Time `json:"fetched_at,omitempty"` // The rank Rank int32 `json:"rank,omitempty"` }
Rank struct for Rank
type Rankings ¶
type Rankings struct {
Alexa []Rank `json:"alexa,omitempty"`
}
Rankings struct for Rankings
type RelatedStories ¶
type RelatedStories struct { // An array of related stories for the input story RelatedStories []Story `json:"related_stories,omitempty"` // The input story body StoryBody string `json:"story_body,omitempty"` // The input story language StoryLanguage string `json:"story_language,omitempty"` // The input story title StoryTitle string `json:"story_title,omitempty"` // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` }
RelatedStories Story containing new V3 entities - available for new_v3_entities feature flag
type RepresentativeStory ¶
type RepresentativeStory struct { // ID of the story which is a unique identification Id int64 `json:"id,omitempty"` // The story permalink URL Permalink string `json:"permalink,omitempty"` // Published date of the story PublishedAt time.Time `json:"published_at,omitempty"` // Title of the story Title string `json:"title,omitempty"` }
RepresentativeStory struct for RepresentativeStory
type Scope ¶
type Scope struct { // The scope by city City string `json:"city,omitempty"` // The source scope by country code. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. Country string `json:"country,omitempty"` Level ScopeLevel `json:"level,omitempty"` // The scope by state State string `json:"state,omitempty"` }
Scope struct for Scope
type ScopeLevel ¶
type ScopeLevel string
ScopeLevel The scope by level
const ( INTERNATIONAL ScopeLevel = "international" NATIONAL ScopeLevel = "national" LOCAL ScopeLevel = "local" )
List of ScopeLevel
type Sentiment ¶
type Sentiment struct { Polarity SentimentPolarity `json:"polarity,omitempty"` // Polarity score of the sentiment Score float64 `json:"score,omitempty"` }
Sentiment struct for Sentiment
type SentimentPolarity ¶
type SentimentPolarity string
SentimentPolarity Polarity of the sentiment
const ( POSITIVE SentimentPolarity = "positive" NEUTRAL SentimentPolarity = "neutral" NEGATIVE SentimentPolarity = "negative" )
List of SentimentPolarity
type Sentiments ¶
type Sentiments struct { Body Sentiment `json:"body,omitempty"` Title Sentiment `json:"title,omitempty"` }
Sentiments struct for Sentiments
type ServerConfiguration ¶
type ServerConfiguration struct { Url string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
type ServerVariable ¶
ServerVariable stores the information about a server variable
type ShareCount ¶
type ShareCount struct { int32 `json:"count,omitempty"` FetchedAt time.Time `json:"fetched_at,omitempty"` }Count
ShareCount struct for ShareCount
type ShareCounts ¶
type ShareCounts struct { ShareCount `json:"facebook,omitempty"` GooglePlus []ShareCount `json:"google_plus,omitempty"` Linkedin []ShareCount `json:"linkedin,omitempty"` Reddit []ShareCount `json:"reddit,omitempty"` }Facebook []
ShareCounts struct for ShareCounts
type Source ¶
type Source struct { // A general explanation about the source Description string `json:"description,omitempty"` // The domain name of the source which is extracted from the source URL Domain string `json:"domain,omitempty"` // The home page URL of the source HomePageUrl string `json:"home_page_url,omitempty"` // The source id which is a unique value Id int32 `json:"id,omitempty"` // The number of websites that link to the source LinksInCount int32 `json:"links_in_count,omitempty"` // The source locations which are tend to be the physical locations of the source, e.g. BBC headquarter is located in London. Locations []Location `json:"locations,omitempty"` // A URL which points to the source logo LogoUrl string `json:"logo_url,omitempty"` // The source name Name string `json:"name,omitempty"` Rankings Rankings `json:"rankings,omitempty"` // The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international. Scopes []Scope `json:"scopes,omitempty"` // The title of the home page URL Title string `json:"title,omitempty"` }
Source struct for Source
type Stories ¶
type Stories struct { // The next page cursor NextPageCursor string `json:"next_page_cursor,omitempty"` // An array of stories Stories []Story `json:"stories,omitempty"` // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` // Notifies about possible issues that occurred when searching for stories Warnings []Warning `json:"warnings,omitempty"` }
Stories Stories containing new V3 entities - available for new_v3_entities feature flag
type Story ¶
type Story struct { Author Author `json:"author,omitempty"` // Body of the story Body string `json:"body,omitempty"` // Suggested categories for the story Categories []Category `json:"categories,omitempty"` // Character count of the story body CharactersCount int32 `json:"characters_count,omitempty"` // An array of clusters the story is associated with Clusters []int64 `json:"clusters,omitempty"` // An array of entities Entities []Entity `json:"entities,omitempty"` Hashtags []string `json:"hashtags,omitempty"` // ID of the story which is a unique identification Id int64 `json:"id,omitempty"` // Extracted keywords mentioned in the story title or body Keywords []string `json:"keywords,omitempty"` // Language of the story Language string `json:"language,omitempty"` Links StoryLinks `json:"links,omitempty"` // An array of extracted media such as images and videos Media []Media `json:"media,omitempty"` // Paragraph count of the story body ParagraphsCount int32 `json:"paragraphs_count,omitempty"` // Publication time of the story, if available, otherwise time of acquisition PublishedDatetime time.Time `json:"published_datetime,omitempty"` // Acquisition time of the story PublishedAt time.Time `json:"published_at,omitempty"` // Sentence count of the story body SentencesCount int32 `json:"sentences_count,omitempty"` Sentiment Sentiments `json:"sentiment,omitempty"` Source Source `json:"source,omitempty"` Summary Summary `json:"summary,omitempty"` // Title of the story Title string `json:"title,omitempty"` Translations StoryTranslations `json:"translations,omitempty"` // Word count of the story body WordsCount int32 `json:"words_count,omitempty"` // License type of the story LicenseType int32 `json:"license_type,omitempty"` // An array of industries categories Industries []Category `json:"industries,omitempty"` }
Story struct for Story
type StoryCluster ¶
type StoryCluster struct { // A unique identification for the cluster Id int64 `json:"id,omitempty"` // Suggested labels for the cluster Phrases []string `json:"phrases,omitempty"` // The cluster score Score float64 `json:"score,omitempty"` // Size of the cluster Size int32 `json:"size,omitempty"` // Story ids which are in the cluster Stories []int64 `json:"stories,omitempty"` }
StoryCluster struct for StoryCluster
type StoryLinks ¶
type StoryLinks struct { // The story canonical URL Canonical string `json:"canonical,omitempty"` // The clusters endpoint URL for this story Clusters string `json:"clusters,omitempty"` // The story permalink URL Permalink string `json:"permalink,omitempty"` // The related stories URL RelatedStories string `json:"related_stories,omitempty"` }
StoryLinks struct for StoryLinks
type StoryTranslation ¶
type StoryTranslation struct { // Translation of body Body string `json:"body,omitempty"` // Translation of title Title string `json:"title,omitempty"` }
StoryTranslation struct for StoryTranslation
type StoryTranslations ¶
type StoryTranslations struct {
En StoryTranslation `json:"en,omitempty"`
}
StoryTranslations Translations of the story. Each language has it's own key and object
type StoryTranslationsEn ¶
type StoryTranslationsEn struct { // Translation of body Body string `json:"body,omitempty"` // Translation of a concatenation of title and body Text string `json:"text,omitempty"` // Translation of title Title string `json:"title,omitempty"` }
StoryTranslationsEn struct for StoryTranslationsEn
type Summary ¶
type Summary struct { // An array of the suggested summary sentences Sentences []string `json:"sentences,omitempty"` }
Summary struct for Summary
type TimeSeries ¶
type TimeSeries struct { // The count of time series bin Count int32 `json:"count,omitempty"` // The published date of the time series bin PublishedAt time.Time `json:"published_at,omitempty"` Sentiment AggregatedSentiment `json:"sentiment,omitempty"` }
TimeSeries struct for TimeSeries
type TimeSeriesList ¶
type TimeSeriesList struct { // The size of each date range expressed as an interval to be added to the lower bound. Period string `json:"period,omitempty"` // The end published date of the time series PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start published date of the time series PublishedAtStart time.Time `json:"published_at.start,omitempty"` // An array of time series TimeSeries []TimeSeries `json:"time_series,omitempty"` }
TimeSeriesList struct for TimeSeriesList
type Trend ¶
type Trend struct { // The count of the trend Count int32 `json:"count,omitempty"` Sentiment AggregatedSentiment `json:"sentiment,omitempty"` // The value of the trend Value string `json:"value,omitempty"` }
Trend struct for Trend
type Trends ¶
type Trends struct { // The field of trends Field string `json:"field,omitempty"` // The end of a period in which searched stories were published PublishedAtEnd time.Time `json:"published_at.end,omitempty"` // The start of a period in which searched stories were published PublishedAtStart time.Time `json:"published_at.start,omitempty"` // An array of trends Trends []Trend `json:"trends,omitempty"` }
Trends struct for Trends
type Warning ¶ added in v4.7.0
type Warning struct { // The detailed description of the warning. Detail string `json:"detail,omitempty"` // The identfier of the warning, represents its origin. Id string `json:"id,omitempty"` Links ErrorLinks `json:"links,omitempty"` }
Warning struct for Warning
Source Files ¶
- api_default.go
- client.go
- configuration.go
- model_aggregated_sentiment.go
- model_author.go
- model_autocomplete.go
- model_autocompletes.go
- model_category.go
- model_category_links.go
- model_category_taxonomy.go
- model_cluster.go
- model_clusters.go
- model_coverages.go
- model_deprecated_entities.go
- model_deprecated_entity.go
- model_deprecated_entity_surface_form.go
- model_deprecated_related_stories.go
- model_deprecated_stories.go
- model_deprecated_story.go
- model_duns_number.go
- model_entities.go
- model_entity.go
- model_entity_in_text.go
- model_entity_links.go
- model_entity_mention.go
- model_entity_mention_index.go
- model_entity_sentiment.go
- model_entity_surface_form.go
- model_error.go
- model_error_links.go
- model_errors.go
- model_external_ids.go
- model_histogram_interval.go
- model_histograms.go
- model_location.go
- model_logicals.go
- model_media.go
- model_media_format.go
- model_media_type.go
- model_nested_entity.go
- model_parameter.go
- model_query.go
- model_rank.go
- model_rankings.go
- model_related_stories.go
- model_representative_story.go
- model_scope.go
- model_scope_level.go
- model_sentiment.go
- model_sentiment_polarity.go
- model_sentiments.go
- model_share_count.go
- model_share_counts.go
- model_source.go
- model_stories.go
- model_story.go
- model_story_cluster.go
- model_story_links.go
- model_story_translation.go
- model_story_translations.go
- model_story_translations_en.go
- model_summary.go
- model_time_series.go
- model_time_series_list.go
- model_trend.go
- model_trends.go
- model_warning.go
- response.go