Sign in

v1

latestOpenAPI 3.1.02026-08-041911887.3 KB
Risk Events

Risk Events Search

With our risk events search you can find significant events that impact business risk, extracted from our dataset of global news.

Events are derived from news content and clustered on a daily basis. Each event instance is labelled according to the Risk Event Definition it matched. It also includes information about the entities that instigated the event ("actors"), and those directly impacted ("targets").

Search query criteria

Construct a query to find events of interest by specifying matching criteria. The matching criteria are expressed in a where clause of the request body (see below). This works in a similar way to Content Search, however there is a more limited set of criteria and exclude clauses are not supported.

The criteria available are:

  • the entities that were involved in the event, either as actors or targets
  • the event definitions
  • a date range of when the event was first reported

The returned data will be paginated, with a maximum of 100 results per page depending on the requested size paramater. For more information see the Pagination docs.

Risk event metadata returned

  • unique event ID
  • the definition the event matched
  • the date the event was first reported
  • the date we first detected the event (normally the same as first reported)
  • the entities who were the "actors" in the event i.e. those that instigated or caused the event
  • the entities who were the "targets" of the event i.e. those who were directly impacted by the event
  • a list of documents that mentioned the event - id, headline and link will be provided, additional metadata can be retrieved using the Get Document endpoint
post/risk-events-search

Request body

sizenumber

Set the number of events to return per page

from-cursorstring

Use the next-cursor field from a previous response to get the next page of results (see Pagination)

Example request

{
  "where": {
    "first-reported-at": {
      "gte": "2023-01-01",
      "lte": "2023-01-01"
    },
    "entities": {
      "id": {
        "any": [
          "bcd2d868-ed38-4382-b94a-622a30fc3215"
        ]
      }
    },
    "event-definitions": {
      "id": {
        "any": [
          "bcd2d868-ed38-4382-b94a-622a30fc3215"
        ]
      }
    }
  }
}

Response

Returns a list of events matching the query

next-cursorstring

Use the next-cursor field from a previous response to get the next page of results (see Pagination)

Example response

{
  "events": [
    {
      "id": "bcd2d868-ed38-4382-b94a-622a30fc3215",
      "first-reported": "2023-01-01",
      "first-detected": "2023-01-01",
      "actors": [
        {
          "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
        }
      ],
      "targets": [
        {
          "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
        }
      ],
      "documents": [
        {
          "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
        }
      ]
    }
  ]
}