Event Rules and Notifications

Endpoints to view event rules for monitoring and retrieve notifications triggered by changes in monitored companies.

Operations

List Company Events

Request

Endpoint to return a collection of events for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your portfolios.

Security

bearerToken

Path

idstringrequired

The connectId of the company that you wish to retrieve events for.

Query

startDatestring, (date-time)

The start date on which results are filtered.

endDatestring, (date-time)

The end date on which results are filtered.

pageinteger

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

Default:0

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/companies/{id}/events?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&page=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"

totalCountnumber

The total number of events returned for the given company.

Example:1

dataArray of objects

pagingobject(ConnectMonitoringPaging)

Paging parameters.

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "totalCount": 1,
  "data": [
    { … }
  ],
  "paging": {
    "size": 10,
    "prev": 0,
    "next": 2,
    "last": 3
  }
}