Get event details

Obtain details about a single event.

The endpoint can be used to retrieve detailed information about a single event of interest. The event of interest should be provided with the eventUri parameter.

For each event you can retrieve multiple properties. The most common is retrieving the list of articles that report about the event. Alternatively, you can also generate various summaries, by using some other returnType value. The return type keywordAggr will, for example, return the top keywords that are mentioned in the articles about the event.

If you would like to retrieve only a subset of articles assigned to the event, you can do so by specifying one of the available filters (keyword, conceptUri, etc.).

Endpointhttps://eventregistry.org/api/v1/event/getEvent
HeadersContent-Type: application/json

Get articles that belong to a particular event with a given URI.

Request body

Parameters 
apiKey  string (required)

Your API key

eventUri  string (required)

Specify the URI of the event you would like to see returned.

resultType  string | string[]

Define what kind of results you would like to get. Each result type corresponds to the prefix that'll be used for other parameters.

Available values:  info, articles, articleUris, keywordAggr, sourceExAggr, dateMentionAggr, articleTrend, similarEvents
Default value:  info
articlesLang  string | string[]

If resultType is articles then use this parameter if you wish to obtain only articles about the event in specific language(s).

articlesIncludeDuplicates  boolean

If resultType is articles then set this value to true in order to return also articles that are copies of other articles (possibly from other news sources).

Default value:  false
Filters 

Click to see possible parameters that you can specify to filter event's articles to a subset based on your criteria

keyword  string | string[]

Find articles that mention the specified keyword or a phrase. You can specify at most 60 keywords in a single search. If you specify multiple keyword parameters, then only articles that mention all of them will be returned, unless you specify keywordOper parameter and set it to or. Use the keywordSearchMode parameter to control how the keyword is matched; see the keyword search modes section.

Example value:  Barack Obama
conceptUri  string | string[]

Find articles that mention the concept with a concept uri. You can specify at most 50 concepts in a single search. If multiple conceptUri parameters are provided, then only articles that are about all specified concepts will be returned, unless you specify conceptOper parameter and set it to or. Check autosuggest methods to get concept URI value for a specified concept label.

Example value:  http://en.wikipedia.org/wiki/World_Health_Organization
categoryUri  string | string[]

Find articles that are assigned to a particular category. You can specify at most 20 categories in a single search. If multiple categoryUri parameters are provided, then articles that are about any of the specified categories will be returned, unless you specify categoryOper parameter and set it to and. Check autosuggest methods to get value for a specified category name.

Example value:  dmoz/Business/Accounting
sourceUri  string | string[]

Find articles that have been published by a news source. If you specify multiple sourceUri parameters, then articles from any of the specified sources will be returned. Check autosuggest methods to get value for a source name.

Example value:  bbc.co.uk
sourceLocationUri  string | string[]

Find articles that were published by news sources located at the given geographic location (city or country). If you specify multiple sourceLocationUri parameters, then articles from sources from any of the specified sources will be returned. Check autosuggest methods to get value for a location name.

Example value:  http://en.wikipedia.org/wiki/Germany
sourceGroupUri  string | string[]

Find articles that were published by news sources that are assigned to some predefined group of news sources.

Example value:  general/ERtop10
authorUri  string | string[]

Find articles that were written by a particular author. Check autosuggest methods to get value for author uri based on the author name (and potentially source url).

Example value:  mark_mazzetti@nytimes.com
locationUri  string | string[]

Find articles that describe something that occured at a particular location (based on the location mentioned in the dateline). Check autosuggest methods to get value for a location name. NOTE: If a location will not be specified in the dateline (immediate start of the article), the article will not be returned. Consider also using conceptUri to find articles that mention a particular location.

Example value:  http://en.wikipedia.org/wiki/United_States
dateStart  string

The starting date on or after the articles of interest were published. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-03
dateEnd  string

The last date on which the articles of interest were published. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
dateMentionStart  string

Ignore events that contain one or more articles that explicitly mention a date that is equal or greater than dateMentionStart. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
dateMentionEnd  string

Ignore events that contain one or more articles that explicitly mention a date that is lower or equal to dateMentionEnd. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
keywordLoc  string

What data should be used when searching using the keywords provided by keywords parameter.

Available values:  body, title, title,body
Default value:  body
keywordOper  string

If more keywords are provided with the keyword parameter, what should be the Boolean operator used. If and (default) then all of the specified keywords have to be present in the article; if or then an article will be returned if it mentions any of the provided keywords.

Available values:  and, or
Default value:  and
keywordSearchMode  string

Determines how the keywords provided with the keyword parameter are matched against the content. Use phrase (default) to match the keyword as an exact phrase, exact to use the Boolean query language (with AND, OR, NOT, NEAR and NEXT operators), or simple for a relevance-based search that does not require all terms to be present. See the keyword search modes section for details and examples.

Available values:  phrase, exact, simple
Default value:  phrase
conceptOper  string

If more concepts are provided with the conceptUri parameter, what should be the Boolean operator used. If and (default) then all of the specified concepts have to be present in the article; if or then an article will be returned if it mentions any of the provided concepts.

Available values:  and, or
Default value:  and
categoryOper  string

If more categories are provided with the categoryUri parameter, what should be the Boolean operator used. If and then all of the specified categories have to be present in the article; if or then an article will be returned if it mentions any of the provided categories.

Available values:  and, or
Default value:  or
startSourceRankPercentile  integer

Starting ranking percentile of the sources to consider in the results (default: 0). Value should be in range 0-90 and divisible by 10.

Default value:  0
endSourceRankPercentile  integer

Ending ranking percentile of the sources to consider in the results (default: 100). Value should be in range 10-100 and divisible by 10.

Default value:  100
minSentiment  integer

The minimum value of the sentiment, the article should have. Valid value is any floating number between -1 (very negative) to 1 (very positive). 0 represents neutral sentiment. Note that setting the value will automatically reduce results to just English articles, since the sentiment can only be computed for English language.

maxSentiment  integer

The maximum value of the sentiment, the article should have. Valid value is any floating number between -1 (very negative) to 1 (very positive). 0 represents neutral sentiment. Note that setting the value will automatically reduce results to just English articles, since the sentiment can only be computed for English language.

Returned Details 

The API call can return more or less meta-data information about the events, articles, concepts, categories, sources and locations. Click to see the available properties that can be specified to determine the amount of returned information.

includeEventTitle  boolean

Set this parameter to true to include the event title in the response.

Default value:  true
includeEventSummary  boolean

Set this parameter to true to include the event title in the response.

Default value:  false
includeEventSocialScore  boolean

Set this parameter to true to include the event social score in the response.

Default value:  false
includeEventSentiment  boolean

Set this parameter to true to include the event sentiment in the response.

Default value:  true
includeEventLocation  boolean

Set this parameter to true to include the event location in the response.

Default value:  true
includeEventDate  boolean

Set this parameter to true to include the event date in the response.

Default value:  true
includeEventArticleCounts  boolean

Set this parameter to true to include the article counts for events in the response.

Default value:  true
includeEventConcepts  boolean

Set this parameter to true to include the event concepts in the response.

Default value:  true
includeEventCategories  boolean

Set this parameter to true to include the event categories in the response.

Default value:  true
includeEventCommonDates  boolean

Set this parameter to true to include the event commmon dates in the response.

Default value:  false
includeEventStories  boolean

Set this parameter to true to include the event stories in the response.

Default value:  false
eventImageCount  integer

Define how many images you would like to have in the response.

Default value:  0
includeConceptLabel  boolean

Set this parameter to true to include the concept label in the response.

Default value:  true
includeConceptImage  boolean

Set this parameter to true to include the concept image in the response.

Default value:  false
includeConceptSynonyms  boolean

Set this parameter to true to include the concept synonyms in the response.

Default value:  false
conceptLang  string

Define the language of the concept label.

Default value:  eng
includeStoryBasicStats  boolean

Set this parameter to true to include story basic stats in the response.

Default value:  false
includeStoryTitle  boolean

Set this parameter to true to include the story title in the response.

Default value:  false
includeStoryLocation  boolean

Set this parameter to true to include the story location in the response.

Default value:  false
includeStoryDate  boolean

Set this parameter to true to include the story date in the response.

Default value:  false
includeStoryConcepts  boolean

Set this parameter to true to include the story concepts in the response.

Default value:  false
includeStoryCategories  boolean

Set this parameter to true to include the story categories in the response.

Default value:  false
includeStoryMedoidArticle  boolean

Set this parameter to true to include story medoid article in the response.

Default value:  false
includeStoryCommonDates  boolean

Set this parameter to true to include story common dates in the response.

Default value:  false
storyImageCount  integer

Define how many images you would like to have in the response.

Default value:  0
includeArticleTitle  boolean

Set this parameter to true to include the article title in the response.

Default value:  true
includeArticleBasicInfo  boolean

Set this parameter to true to include the core article information in the response.

Default value:  true
includeArticleBody  boolean

Set this parameter to true to include the article body in the response.

Default value:  true
includeArticleEventUri  boolean

Set this parameter to true to include the uri of the event (to which the article belongs) in the response.

Default value:  true
includeArticleSocialScore  boolean

Set this parameter to true to include the information about how many times the article was shared on different social media.

Default value:  false
includeArticleSentiment  boolean

Set this parameter to true to include the article sentiment in the response (value will be non-null only for English articles).

Default value:  true
includeArticleConcepts  boolean

Set this parameter to true to include the article concepts in the response.

Default value:  false
includeArticleCategories  boolean

Set this parameter to true to include the article categories in the response.

Default value:  false
includeArticleLocation  boolean

Set this parameter to true to include the article location in the response.

Default value:  false
includeArticleImage  boolean

Set this parameter to true to include the article image in the response.

Default value:  true
includeArticleAuthors  boolean

Set this parameter to true to include the article authors in the response.

Default value:  true
includeArticleVideos  boolean

Set this parameter to true to include the article videos in the response.

Default value:  false
includeArticleLinks  boolean

Set this parameter to true to include the article links in the response.

Default value:  false
includeArticleExtractedDates  boolean

Set this parameter to true to include article extracted dates in the response.

Default value:  false
includeArticleDuplicateList  boolean

Set this parameter to true to include the list of duplicate articles in the response.

Default value:  false
includeArticleOriginalArticle  boolean

Set this parameter to true to include the original article in the response.

Default value:  false
articleBodyLen  integer

Set the size of the article body that'll be returned in the response. Use -1 for full article body.

Default value:  -1
includeSourceTitle  boolean

Set this parameter to true to include the source title in the response.

Default value:  true
includeSourceDescription  boolean

Set this parameter to true to include the source description in the response.

Default value:  false
includeSourceLocation  boolean

Set this parameter to true to include the source location in the response.

Default value:  false
includeSourceRanking  boolean

Set this parameter to true to include the source ranking in the response.

Default value:  false
includeLocationPopulation  boolean

Set to true to include the population size of the location.

Default value:  false
includeLocationGeoNamesId  boolean

Set to true to include the GeoNames id of the location.

Default value:  false
includeLocationCountryArea  boolean

Set to true to include the are of the location in squared km.

Default value:  false
includeLocationCountryContinent  boolean

Set to true to get the continent of the country for location objects.

Default value:  false