Skip to main content

Retrieve notification logs

GET 
/api/v1/notifications/logs

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

Request​

Query Parameters

    notificationRunIds int64[]

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

    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: [READY, IGNORED, FAILED, DELIVERED]

    The status of the notification.

    recipientTypes string[]

    Possible values: [USER, GROUP]

    The type of the notification recipient.

    recipientEmails string[]

    The email address that this notification was sent to.

    recipientEntityIds int64[]

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

    recipientChannels string[]

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

    mediums string[]

    Possible values: [SLACK, MICROSOFT_TEAMS, EMAIL]

    The medium used to send the notification.

    ignoredReasons string[]

    Possible values: [USER_UNSUBSCRIBED, WORKSPACE_DISABLED, TEAM_MEMBER_DISABLED, CHANNEL_DISABLED, SCORECARD_DISABLED, DUPLICATE, CORTEX_EMPLOYEE, NON_CORTEX_USERS_DISABLED, UNSUPPORTED]

    The reason why a notification was ignored.

    failedReasons string[]

    Possible values: [CHANNEL_NOT_FOUND, MEMBER_EMAILS_NOT_FOUND, MISSING_CONTENT, CLIENT_ERROR, UNEXPECTED_ERROR, BACKSTAGE_BASE_URL_MISSING, NO_SEATS_LEFT]

    The reason why a notification failed to send.

    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​

Successfully retrieved notification logs

Schema

    logs

    object[]

    required

  • Array [

    • dateCreated date-time

    The date and time that this notification was created.

    dateDelivered date-time

    The date and time that this notification was delivered.

    dateUpdated date-time

    The date and time that this notification was updated.

    errorMessage string

    An additional error message.

    failedReason string

    Possible values: [CHANNEL_NOT_FOUND, MEMBER_EMAILS_NOT_FOUND, MISSING_CONTENT, CLIENT_ERROR, UNEXPECTED_ERROR, BACKSTAGE_BASE_URL_MISSING, NO_SEATS_LEFT]

    The reason why this notification failed.

    id int64required

    The unique identifier of the notification log.

    ignoredReason string

    Possible values: [USER_UNSUBSCRIBED, WORKSPACE_DISABLED, TEAM_MEMBER_DISABLED, CHANNEL_DISABLED, SCORECARD_DISABLED, DUPLICATE, CORTEX_EMPLOYEE, NON_CORTEX_USERS_DISABLED, UNSUPPORTED]

    The reason why this notification was ignored.

    medium stringrequired

    Possible values: [SLACK, MICROSOFT_TEAMS, EMAIL]

    The medium used to send the notification.

    recipientChannel string

    The channel in Slack or MS Teams that this notification was sent to.

    recipientEmail string

    The email address that this notification was sent to.

    recipientEntityId int64

    The unique identifier of the entity that this notification was sent to.

    recipientType stringrequired

    Possible values: [USER, TEAM, ENTITY]

    The type of the notification recipient.

    recipientUserId int64

    The unique identifier of the Cortex user that this notification was sent to.

    runId int64required

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

    status stringrequired

    Possible values: [READY, IGNORED, FAILED, DELIVERED]

    The status of the notification log.

    type 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.

  • ]

    • page int32required

    Current page number, 0-indexed

    total int32required

    Total number of results

    totalPages int32required

    Total number of pages

Loading...