COconfluent
User Notifications (notifications/v1)

Get notification summary

Early Access Request Access To User Notifications API v1

Returns the authenticated user's total unread notification count along with a breakdown by severity.

get/notifications/v1/user-notifications:summary

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/notifications/v1/user-notifications:summary
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Response

Notification summary.

api_version'notifications/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'Summary' required

Kind defines the object this REST resource represents.

unread_countinteger required

Total number of unread notifications.

Example response

{
  "unread_count": 14,
  "severities": [
    {
      "severity": "CRITICAL",
      "count": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.