# 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**

\ <br>

## 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)                                 |

<br>

### 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 >}}

<br>

### stat

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

\ <br>

## 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*

  <br>

### 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.*

  <br>

### 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.*

  <br>

### NotificationUsagesInfo

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

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

  *Total counts of queried Notification Usage.*

  <br>