Retrieves a list of events based on the provided query parameters. Supports filtering by event type, date range, and pagination.
Subscription Endpoint
This endpoint has a special subscription requirement. Your API Key needs to be subscribed to this endpoint in order to access it; otherwise it will return a 403 Forbidden error. Please contact Forestreet support to get subscribed.
An Event is a collection of one or more Observations that all refer to the same underlying occurrence. For example, if a company is acquired, there may be multiple news articles about the acquisition, and each article would be an Observation. However, all of these Observations would be grouped under a single Event that represents the acquisition itself.
The grouping of Events is subjective to some extent; a different person may group Observations differently based on their interpretation. Our system uses a community detection algorithm on a graph of Observations linked up by proprietary heuristics to determine which Observations belong to the same Event. These may not always align with everyone’s intuition, and we are continuously working to improve our algorithms and welcome user feedback on any misgroupings they observe.
Pass a static API key for every request, provided by your customer support.
Number of items per page, default is 10, minimum is 1, maximum is 100.
1 <= x <= 100Current page number, default is 1.
x >= 1Start of lastUpdated date range (ISO 8601). Defaults to 00:00 UTC if no time provided.
End of lastUpdated date range (ISO 8601). Defaults to 23:59 UTC if no time provided.
Comma-separated list of affected datapoint names (OR within, AND with other filters).
Comma-separated list of alert type names (OR within, AND with other filters).
Comma-separated list of impacted entity names (OR within, AND with other filters).
The response containing pagination metadata, and an array of zero or more events that satisfy the query parameters.
Schema for pagination metadata, including total items, total pages, current page, and page size.
{
"totalItems": 123,
"totalPages": 13,
"currentPage": 1,
"pageSize": 10,
"unfilteredTotalItems": 196,
"unfilteredTotalPages": 20
}
A list of events matching the query parameters, within the specified page and page size.