COcortex
Notification Logs

Retrieve notification runs

Changed on

Retrieve notification runs based on the provided filters. API key must have the View Notification logs permission.

get/api/v1/notifications/logs/run

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/notifications/logs/run
  • Auth
    HTTP bearer

Query parameters

notificationTypesstring[]

The type of notification.

statusesstring[]

The status of the notification.

mediumsstring[]

The medium used to send the notification.

ignoredReasonsstring[]

The reason why a notification run was ignored.

failedReasonsstring[]

The reason why a notification run failed.

includeObjectsboolean

Whether to include the objects associated with the notification run.

fromDatestring date-time

The ISO date and time to start the search from.

untilDatestring date-time

The ISO date and time to end the search at.

deliveredOnlyboolean
pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

orderBy'ASC' | 'DESC'

Sort the results ascending or descending.

Response

Successfully retrieved notification runs

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "runs": [
    {
      "id": 1,
      "notificationObjects": [
        {
          "cid": "en2da8159dbeefb974",
          "tag": "production-readiness-scorecard"
        }
      ]
    }
  ]
}

Changes