Get a DemoCortex AcademyWebsiteStatusLogin

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
AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters
notificationRunIdsinteger · int64[]Optional

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

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.

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 · int32Required

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

Default: 250
pageinteger · int32Required

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

Default: 0
orderBystring · enumOptional

Sort the results ascending or descending.

Default: DESCPossible values:
Responses
200

Successfully retrieved notification logs

application/json
get
/api/v1/notifications/logs
GET /api/v1/notifications/logs?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "logs": [
    {
      "dateCreated": "2025-11-14T22:52:07.793Z",
      "dateDelivered": "2025-11-14T22:52:07.793Z",
      "dateUpdated": "2025-11-14T22:52:07.793Z",
      "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
}

Retrieve notification runs

get

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

Authorizations
AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters
searchQueryanyOptional

A search query to filter the results.

includeObjectsbooleanOptional

Whether to include the objects associated with the notification run.

Default: false
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
deliveredOnlybooleanOptionalDefault: true
pageSizeinteger · int32Required

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

Default: 250
pageinteger · int32Required

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

Default: 0
orderBystring · enumOptional

Sort the results ascending or descending.

Default: DESCPossible values:
Responses
200

Successfully retrieved notification runs

application/json
get
/api/v1/notifications/logs/run
GET /api/v1/notifications/logs/run?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "runs": [
    {
      "dateCreated": "2025-11-14T22:52:07.793Z",
      "dateUpdated": "2025-11-14T22:52:07.793Z",
      "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
}

Last updated

Was this helpful?