> ## Documentation Index
> Fetch the complete documentation index at: https://doc.va777.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 查詢活動獎勵

> 查詢活動獎勵 API 的請求參數、回應格式與回應訊息碼。

> [!NOTE]
>
> * 查詢活動派彩總額紀錄。
> * 可查詢3個月內資料。

## 請求路徑

```text theme={null}
GET {host}/api/v1.0/event/report/prize
```

## Headers

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="56%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`Authorization`</td><td>string</td><td>是</td><td>驗證令牌，由我方提供</td></tr>
  </tbody>
</table>

## 請求參數

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="11%" />

    <col width="45%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>參與簽章</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`eventID`</td><td>string</td><td>否</td><td>✓</td><td>活動編號(允許字元:`a-z A-Z 0-9 _`)</td></tr>
    <tr><td>`sign`</td><td>string</td><td>是</td><td /><td>簽章，產生方式請參考[簽章規則](https://doc.va777.net/zh-Hant/v1/guides/signature.md)</td></tr>
  </tbody>
</table>

## 回應

成功（HTTP 狀態碼固定為 200，請以 `status.code` 判斷結果）

<table>
  <colgroup>
    <col width="34%" />

    <col width="12%" />

    <col width="54%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`data`</td><td>object</td><td /></tr>
    <tr><td>`data.list`</td><td>object</td><td>活動獎勵清單</td></tr>
    <tr><td>`data.list.eventID`</td><td>string</td><td>活動編號</td></tr>
    <tr><td>`data.list.eventName`</td><td>string</td><td>活動名稱</td></tr>
    <tr><td>`data.list.currency`</td><td>string</td><td>幣別</td></tr>
    <tr><td>`data.list.totalPayout`</td><td>number</td><td>總獎勵點數</td></tr>
    <tr><td>`data.list.totalCurrencyKindPayout`</td><td>number</td><td>總獎勵金額</td></tr>
    <tr><td>`data.list.startTime`</td><td>string</td><td>活動開始時間(時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v1/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.list.endTime`</td><td>string</td><td>活動結束時間(時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v1/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.count`</td><td>number</td><td>筆數</td></tr>
    <tr><td>`status`</td><td>object</td><td>回應狀態，請參考[回應格式](https://doc.va777.net/zh-Hant/v1/guides/request-format.md#回應格式)</td></tr>
  </tbody>
</table>

### 回應範例

```json theme={null}
{
  "data": {
    "count": 1,
    "list": {
      "eventID": "asda_dsf4cger",
      "eventName": "atestevent",
      "currency": "CNY",
      "totalPayout": "155",
      "totalCurrencyKindPayout": "155",
      "startTime": "2022-07-01T10:13:54.920+08:00",
      "endTime": "2022-07-02T11:13:54.920+08:00"
    }
  },
  "status": {
    "code": "0",
    "message": "success",
    "datetime": "2022-07-01T10:13:54.920+08:00",
    "traceCode": "7cf25e1957cc47fe8e01f1a7c6d504d6"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.