Return Monitoring Portfolios Notification Events Data By Day

Request

WARNING - This endpoint returns daily event totals for the given range.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

Query

startDatestring, (date-time)required

The start date on which results are filtered.

endDatestring, (date-time)required

The end date on which results are filtered.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

totalCountnumber

The total number of events returned for the given company.

Example:36

dataArray of objects

pagingobject

Paging parameters.

Response

{
  "totalCount": 36,
  "data": [
    { … }
  ],
  "paging": {
    "size": null,
    "prev": null,
    "next": null,
    "last": null
  }
}