Retrieve notification runs

GET 
/api/v1/notifications/logs/run

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

Request

Query Parameters

notificationTypes string[]

Possible values: [INITIATIVE_CREATION, INITIATIVE_CUSTOM_SCHEDULE, INITIATIVE_N_DAYS_LEFT, SERVICE_REEVALUATED, WEEKLY_REPORT, BROKEN_OPEN_API_SPEC, ENTITLEMENT_EXPIRATION, ONCALL_ASSISTANT, ONBOARDING_MESSAGE, NOTIFY_INVALID_INTEGRATION, ONCALL_PERSON_CHANGED, ONCALL_STARTS_IN_N_DAYS, TEAM_MEMBER_INVITATION, PENDING_RULE_EXEMPTION, TOKEN_EXPIRES_IN_N_DAYS, SCHEDULED_SCORECARD_RULE_CREATION, SCORECARD_RULE_ACTIVATES_IN_N_DAYS, WORKFLOW_STATUS_UPDATE, WORKFLOW_APPROVAL_PENDING, VERIFICATION_PERIOD_STARTED, VERIFICATION_PERIOD_REMINDER, AI_ASSISTANT_WELCOME_MESSAGE, ENTITY_SCORE_DROPPED]

The type of notification.

statuses string[]

Possible values: [CREATED, FAILED, IGNORED, COMPLETED, COMPLETED_WITH_ERRORS]

The status of the notification.

mediums string[]

Possible values: [SLACK, MICROSOFT_TEAMS, EMAIL]

The medium used to send the notification.

ignoredReasons string[]

Possible values: [SCORECARD_DISABLED, WORKSPACE_DISABLED, NO_RECIPIENTS]

The reason why a notification run was ignored.

failedReasons string[]

Possible values: [PACKET_GENERATOR_ERROR, CONTEXT_RESOLUTION_ERROR, MISSING_RECIPIENTS, INTERNAL_ERROR]

The reason why a notification run failed.

searchQuery string

A search query to filter the results.

includeObjects boolean

Whether to include the objects associated with the notification run.

fromDate date-time
The ISO date and time to start the search from.
Example: 2021-01-01T00:00:00
untilDate date-time
The ISO date and time to end the search at.
Example: 2021-01-01T00:00:00
pageSize int32required

Default value: 250

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

page int32required

Default value: 0

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

orderBy string

Possible values: [ASC, DESC]

Default value: DESC

Sort the results ascending or descending.

Responses

200

Successfully retrieved notification runs

application/json

Schema

Schema

page int32required

Current page number, 0-indexed

runs

object[]

required

Array [

dateCreated date-time

The date and time that this notification run was created.

dateUpdated date-time

The date and time that this notification run was updated.

deliveredCount int64required

The number of notifications that were delivered during this run.

errorMessage string

An additional error message.

failedReason string

Possible values: [PACKET_GENERATOR_ERROR, CONTEXT_RESOLUTION_ERROR, MISSING_RECIPIENTS, INTERNAL_ERROR]

The reason why this notification run failed.

id int64required

The unique identifier of the notification run.

ignoredReason string

Possible values: [SCORECARD_DISABLED, WORKSPACE_DISABLED, NO_RECIPIENTS]

The reason why this notification run was ignored.

medium stringrequired

Possible values: [SLACK, MICROSOFT_TEAMS, EMAIL]

The medium used to send the notification.

notificationObjects

object[]

The objects (Entities, Scorecards and Initiatives) associated with this run.

Array [

cid string

Unique, immutable, 18-character auto-generated identifier. Applicable only for entities.

id int64required

The unique internal identifier of the notification object.

name stringrequired

The name of the notification object.

tag string

Unique identifier, found in the UI. Applicable for entities and scorecards.

type stringrequired

Possible values: [ENTITY, SCORECARD, INITIATIVE]

The type of the notification object.

url string

The URL of the notification object's home page in Cortex.

]

notificationType stringrequired

Possible values: [INITIATIVE_CREATION, INITIATIVE_CUSTOM_SCHEDULE, INITIATIVE_N_DAYS_LEFT, SERVICE_REEVALUATED, WEEKLY_REPORT, BROKEN_OPEN_API_SPEC, ENTITLEMENT_EXPIRATION, ONCALL_ASSISTANT, ONBOARDING_MESSAGE, NOTIFY_INVALID_INTEGRATION, ONCALL_PERSON_CHANGED, ONCALL_STARTS_IN_N_DAYS, TEAM_MEMBER_INVITATION, PENDING_RULE_EXEMPTION, TOKEN_EXPIRES_IN_N_DAYS, SCHEDULED_SCORECARD_RULE_CREATION, SCORECARD_RULE_ACTIVATES_IN_N_DAYS, WORKFLOW_STATUS_UPDATE, WORKFLOW_APPROVAL_PENDING, VERIFICATION_PERIOD_STARTED, VERIFICATION_PERIOD_REMINDER, AI_ASSISTANT_WELCOME_MESSAGE, ENTITY_SCORE_DROPPED]

The type of the notification.

originalRunId int64

The unique identifier of the original run that this run was re-run from.

seqNo int32required

The order of the run in the sequence of re-runs. 0 if it's the original run.

status stringrequired

Possible values: [CREATED, FAILED, IGNORED, COMPLETED, COMPLETED_WITH_ERRORS]

The status of the notification run.

]

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "page": 0,
  "runs": [
    {
      "dateCreated": "2024-07-29T15:51:28.071Z",
      "dateUpdated": "2024-07-29T15:51:28.071Z",
      "deliveredCount": 0,
      "errorMessage": "string",
      "failedReason": "PACKET_GENERATOR_ERROR",
      "id": 1,
      "ignoredReason": "SCORECARD_DISABLED",
      "medium": "SLACK",
      "notificationObjects": [
        {
          "cid": "en2da8159dbeefb974",
          "id": 0,
          "name": "string",
          "tag": "production-readiness-scorecard",
          "type": "ENTITY",
          "url": "string"
        }
      ],
      "notificationType": "INITIATIVE_CREATION",
      "originalRunId": 0,
      "seqNo": 0,
      "status": "CREATED"
    }
  ],
  "total": 0,
  "totalPages": 0
}

403

Forbidden

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...