# 전자서명 사용량 조회 API

전자서명 사용량을 조회할 수 있는 API를 제공합니다.

<br>

## `GET` kit-api/v1/signatures/usage

Method: GET\
Endpoint: kit-api/v1/signatures/usage

<br>

## Example

```
...kit-api/v1/signatures/usage?createdAtAfter=2024-11-19T06:00:00.000Z
```

<br>

## Request Query

| Key             | Description                           | Required |
| --------------- | ------------------------------------- | -------- |
| createdAtAfter  | 특정시간 이후의 사용량 목록 조회용 파라미터 (ISO UTC 포맷) | no       |
| createdAtBefore | 특정시간 이전의 사용량 목록 조회용 파라미터 (ISO UTC 포맷) | no       |

<br>

## Response

```json
{
  "ok": true,
  "data": {
    "total": 15, // 전체 개수
    "created": 4, // status: CREATED 경우 - 생성되었는데 요청되기 전 상태 (특수 상황)
    "done": 6, // status: DONE 경우 - 체결된 상태
    "waiting": 3, // status: WAITING 경우 - 서명 요청 후 체결 전 상태
    "canceled": 2 // status: CANCELED 경우 - 서명이 취소된 상태
  }
}
```

```json
{
  "ok": false, // api 실패
  "message": "error message", // Error가 존재하면 message(string)로 전달
  "errorCode": "ERROR_CODE"
}
```

<br>