All Notification Events

Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria.

SecuritybearerToken
Request
query Parameters
searchQuery
string

Return notificationEvents that match the given value

sortBy
string
Default: "companyName"

Sort results by this column. Null values of sort column are listed after non-nulls.

Enum: "companyName" "countryCode" "eventId" "eventDate"
sortDir
string
Default: "asc"

The direction that you wish to sort results by.

Enum: "asc" "desc"
startDate
string <date-time>

The start date on which results are filtered.

endDate
string <date-time>

The end date on which results are filtered.

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

pageSize
integer

Number of items to return per Page.

filterByCreatedDate
boolean
Default: false

Set to true to filter the Notification Events of the "createdDate" field when using startDate and endDate parameters. By default this is set to false, with the date parameters filtering using the "eventDate" field.

Enum: false true
Responses
200
400
401
404
get/monitoring/notificationEvents
Request samples
Response samples
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 36,
  • "data": [
    ],
  • "paging": {
    }
}