Get events for a topic page

Obtain events that match a user generated topic page.

Retrieve the events that match the topic page the user generated on the Media Monitoring page.

The topic page has to be created using the web interface and can be defined by a list of concepts, keywords, news sources, categories and other available conditions. Each topic page has a uniqe id, called a URI. When you open the topic page, the URI is displayed in the url in the browser (e.g. "240f6a12-b9d8-40a6-b1c6-a220e31d08de"). Use that URI as the uri parameter when making the API calls.

Compared to the Get Events API call, this endpoint is ideal when you want to find events that match a broader topic that can be defined using a set of concepts, keywords, categories, etc. These concepts and keywords don't all need to be mentioned in an event, but the more of them are mentioned, the higher the event will be in the list of results. By default, the returned events are sorted based on how well they match the topic, but you can also change the sorting by setting the sorting parameter.

The results of the search can be the list of matching events (default) or one of the various aggregates (summaries) of the matching events. In case of the aggregates, for example, the returned data can contain the geographic locations, where the events matching criteria occured, date of the matching events, etc.

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

Retrieve events that match a public topic page related to Renewable energy (with uri 240f6a12-b9d8-40a6-b1c6-a220e31d08de). Return events sorted by relevance (most relevant first).

Request body

Parameters 
apiKey  string (required)

Your API key

uri  string (required)

URI of the topic page for which you wish to retrieve matching events. Obtain the URI from the URL on the monitoring page when the topic page is opened.

resultType  string | string[]

Define what kind of results you would like to get.

Available values:  events, uriWgtList, timeAggr, locAggr, locTimeAggr, sourceAggr, authorAggr, keywordAggr, conceptAggr, conceptGraph, categoryAggr, breakingEvents, sentimentAggr, dateMentionAggr
Default value:  events
eventsPage  integer

Determines the page of the results to return (starting from 1). Relevant when resultType = events.

Default value:  1
eventsCount  integer

Define how many events (up to 50) will be returned. Relevant when resultType = events.

Default value:  50
eventsSortBy  string

Set how you would like to sort your results. date (by event date), rel (relevance to the query), size (number of articles). Relevant when resultType = events.

Available values:  date, rel, size
Default value:  rel
eventsSortByAsc  boolean

Should the results be ordered in ascending order or descending order (default) based on the sorting criteria. Relevant when resultType = events.

Default value:  false
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
includeCategoryParentUri  boolean

Set this parameter to true to include category parent uri 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