# NotificationUsage

A NotificationUsage is a resource indicating daily Protocol usage. The limit set by the resource Quota is applied based on the NotificationUsage.

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

\
\


## NotificationUsage

**NotificationUsage Methods:**

| Method                                                                                                                       | Request                                                                                                                                                              | Response                                                                                                                                                     |
| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#list) | [NotificationUsageQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#notificationusagequery)         | [NotificationUsagesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#notificationusagesinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#stat) | [NotificationUsageStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#notificationusagestatquery) | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#struct)                                 |

\


### list

Gets a list of all NotificationUsages. You can use a query to get a filtered list of Notification Usages.

> **POST** /notification/v1/notification-usage/list

\{{< tabs " list " >\}}

\{{< tab "Request Example" >\}}

[NotificationUsageQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/notification/v1/NotificationUsage/README.md#notificationusagequery)

*   **domain\_id** (string) `Required`

    _The ID of domain._
*   **query** (Query)

    _Query format provided by SpaceONE. Please check the link for more information._
*   **protocol\_id** (string)

    _The ID of Protocol._

\{{< highlight json >\}} { "query": {} } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[NotificationUsagesInfo](#NOTIFICATIONUSAGESINFO)

*   **results** (NotificationUsageInfo) `Repeated` `Required`

    List of queried Notification Usage.
*   **total\_count** (int32) `Required`

    Total counts of queried Notification Usage.

\{{< highlight json >\}} { "results": \[ { "protocol\_id": "protocol-123456789012", "usage\_date": "08", "usage\_month": "2022-05", "count": 2, "domain\_id": "domain-123456789012" }, { "protocol\_id": "protocol-123456789012", "usage\_date": "18", "usage\_month": "2022-05", "count": 7, "domain\_id": "domain-123456789012" } ], "total\_count": 2 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

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

\
\


## Message

### NotificationUsageInfo

*   **protocol\_id** (string) `Required`

    _The ID of Protocol._
*   **usage\_date** (string) `Required`

    _Usage Date._
*   **usage\_month** (string) `Required`

    _Usage Month._
*   **count** (int32) `Required`

    _Usage count using actual notifications._
*   **fail\_count** (int32) `Required`

    _Fail count when dispatching notifications._
*   **domain\_id** (string) `Required`

    _The ID of domain_

    \


### NotificationUsageQuery

*   **domain\_id** (string) `Required`

    _The ID of domain._
*   **query** (Query)

    _Query format provided by SpaceONE. Please check the link for more information._
*   **protocol\_id** (string)

    _The ID of Protocol._

    \


### NotificationUsageStatQuery

*   **query** (StatisticsQuery) `Required`

    _Statistics Query format provided by SpaceONE. Please check the link for more information._
*   **domain\_id** (string) `Required`

    _The ID of domain._

    \


### NotificationUsagesInfo

*   **results** (NotificationUsageInfo) `Repeated` `Required`

    _List of queried Notification Usage._
*   **total\_count** (int32) `Required`

    _Total counts of queried Notification Usage._

    \
