Notification Logs

Use these operations to interact with notification logs in Cortex.

Required permissions

Your API key must have the View notification logs permission.

Operations

Retrieve notification logs

get

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

Authorizations

Query parameters

notificationRunIdsinteger · int64[]optional

The unique identifier of the notification run that this log is associated with.

notificationTypesstring · enum[]optional

The type of notification.

statusesstring · enum[]optional

The status of the notification.

recipientTypesstring · enum[]optional

The type of the notification recipient.

recipientEmailsstring[]optional

The email address that this notification was sent to.

recipientEntityIdsinteger · int64[]optional

The unique identifiers of the entities that the notifications were sent to.

recipientChannelsstring[]optional

The channel in Slack or MS Teams where the notification was sent.

mediumsstring · enum[]optional

The medium used to send the notification.

ignoredReasonsstring · enum[]optional

The reason why a notification was ignored.

failedReasonsstring · enum[]optional

The reason why a notification failed to send.

fromDatestring · date-timeoptional

The ISO date and time to start the search from.

Example: 2021-01-01T00:00:00

untilDatestring · date-timeoptional

The ISO date and time to end the search at.

Example: 2021-01-01T00:00:00

pageSizeinteger · int32 · default: 250required

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

pageinteger · int32 · default: 0required

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

orderBystring · enum · default: "DESC"optional

Sort the results ascending or descending.

Options: ASC, DESC

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/notifications/logs?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

403

429

200

{
  "logs": [
    {
      "dateCreated": "2025-03-29T00:53:06.639Z",
      "dateDelivered": "2025-03-29T00:53:06.639Z",
      "dateUpdated": "2025-03-29T00:53:06.639Z",
      "errorMessage": "text",
      "failedReason": "CHANNEL_NOT_FOUND",
      "id": 1,
      "ignoredReason": "USER_UNSUBSCRIBED",
      "medium": "SLACK",
      "recipientChannel": "#general",
      "recipientEmail": "text",
      "recipientEntityId": 1,
      "recipientType": "USER",
      "recipientUserId": 1,
      "runId": 1,
      "status": "READY",
      "type": "INITIATIVE_CREATION"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully retrieved notification logs

Retrieve notification runs

get

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

Authorizations

Query parameters

notificationTypesstring · enum[]optional

The type of notification.

statusesstring · enum[]optional

The status of the notification.

mediumsstring · enum[]optional

The medium used to send the notification.

ignoredReasonsstring · enum[]optional

The reason why a notification run was ignored.

failedReasonsstring · enum[]optional

The reason why a notification run failed.

searchQuerystringoptional

A search query to filter the results.

includeObjectsboolean · default: falseoptional

Whether to include the objects associated with the notification run.

fromDatestring · date-timeoptional

The ISO date and time to start the search from.

Example: 2021-01-01T00:00:00

untilDatestring · date-timeoptional

The ISO date and time to end the search at.

Example: 2021-01-01T00:00:00

pageSizeinteger · int32 · default: 250required

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

pageinteger · int32 · default: 0required

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

orderBystring · enum · default: "DESC"optional

Sort the results ascending or descending.

Options: ASC, DESC

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/notifications/logs/run?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

403

429

200

{
  "page": 1,
  "runs": [
    {
      "dateCreated": "2025-03-29T00:53:06.639Z",
      "dateUpdated": "2025-03-29T00:53:06.639Z",
      "deliveredCount": 1,
      "errorMessage": "text",
      "failedReason": "PACKET_GENERATOR_ERROR",
      "id": 1,
      "ignoredReason": "SCORECARD_DISABLED",
      "medium": "SLACK",
      "notificationObjects": [
        {
          "cid": "en2da8159dbeefb974",
          "id": 1,
          "name": "text",
          "tag": "production-readiness-scorecard",
          "type": "ENTITY",
          "url": "text"
        }
      ],
      "notificationType": "INITIATIVE_CREATION",
      "originalRunId": 1,
      "seqNo": 1,
      "status": "CREATED",
      "summary": "text"
    }
  ],
  "total": 1,
  "totalPages": 1
}

Successfully retrieved notification runs