> For the complete documentation index, see [llms.txt](https://spaceone-dev.gitbook.io/spaceone-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spaceone-dev.gitbook.io/spaceone-apis/notification/v1/notification-usage.md).

# Notification Usage

> **Package : spaceone.api.notification.v1**

## NotificationUsage

{% hint style="info" %}
**NotificationUsage Methods:**
{% endhint %}

| Method            | Request                                                   | Response                                                                                                           |
| ----------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**list**](#list) | [NotificationUsageQuery](#notificationusagequery)         | [NotificationUsagesInfo](#notificationusagesinfo)                                                                  |
| [**stat**](#stat) | [NotificationUsageStatQuery](#notificationusagestatquery) | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### list

> **GET** /notification/v1/notification-usages
>
> **POST** /notification/v1/notification-usages/search

> Lists for the Notification usage information.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.

| Type     | Message                                           |
| -------- | ------------------------------------------------- |
| Request  | [NotificationUsageQuery](#notificationusagequery) |
| Response | [NotificationUsagesInfo](#notificationusagesinfo) |

### stat

> **POST** /notification/v1/notification-usages/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [NotificationUsageStatQuery](#notificationusagestatquery)                                                          |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

##

## Message

### NotificationUsageInfo

| Field        | Type                                                                                            | Description                                |
| ------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------ |
| protocol\_id | string                                                                                          | The ID of Protocol.                        |
| usage\_date  | string                                                                                          | Usage Date.                                |
| usage\_month | string                                                                                          | Usage Month.                               |
| count        | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | Usage count using actual notifications.    |
| fail\_count  | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | Fail count when dispatching notifications. |
| domain\_id   | string                                                                                          | The ID of domain                           |

### NotificationUsageQuery

| Field        | Type                                                                                               | Required | Description                                                                    |
| ------------ | -------------------------------------------------------------------------------------------------- | :------: | ------------------------------------------------------------------------------ |
| query        | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    | Query format provided by SpaceONE. Please check the link for more information. |
| protocol\_id | string                                                                                             |     ✘    | The ID of Protocol.                                                            |
| domain\_id   | string                                                                                             |     ✔    | The ID of domain.                                                              |

### NotificationUsageStatQuery

| Field      | Type                                                                                                             | Required | Description                                                                               |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------- |
| query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    | Statistics Query format provided by SpaceONE. Please check the link for more information. |
| domain\_id | string                                                                                                           |     ✔    | The ID of domain.                                                                         |

### NotificationUsagesInfo

| Field        | Type                                                                                            | Description                                 |
| ------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------- |
| results      | [list of NotificationUsageInfo](#notificationusageinfo)                                         | List of queried Notification Usage.         |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | Total counts of queried Notification Usage. |