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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://spaceone-dev.gitbook.io/spaceone-apis/notification/v1/notification-usage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.