> For the complete documentation index, see [llms.txt](https://apidocs.nhanh.vn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.nhanh.vn/v3/vpage/bao-cao/capi_event.md).

# Chi tiết event CAPI

* Chi tiết báo cáo CAPI

## Request

* Xem sample Postman.

```curl
curl --location 'https://vpage.open.nhanh.vn/v3.0/report/capievent?appId={{appId}}&businessId={{businessId}}' \
--header 'Authorization: {{accessToken}}' \
--header 'Content-Type: application/json' \
--body '{
  "filters": {
    "pageIds": ["123456789"],
    "events": ["Purchase", "LeadSubmitted"],
    "createdAt": {
      "from": 1787011200,
      "to": 1787616000
    },
    "statuses": [1, 2],
    "orderId": "123456"
  },
  "paginator": {
    "size": 50,
    "sort": {
      "createdAt": "desc"
    }
  }
}'
```

### Filters

| Field        | Kiểu            | Mô tả                                                                                                                                                                             |
| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageIds`    | array\[string]  | Danh sách ID Page cần lấy báo cáo. Nếu không truyền, API lấy dữ liệu của toàn bộ Page mà access token được cấp quyền trong business.                                              |
| `events`     | array\[string]  | Danh sách loại CAPI event cần lấy. Nếu không truyền, API mặc định lấy `Purchase`, `LeadSubmitted`, `OrderCanceled`, `OrderReturned`. Xem bảng Event bên dưới.                     |
| `createdAt`  | object          | Khoảng thời gian tạo event, dùng Unix timestamp theo giây. Nếu không truyền, mặc định từ 00:00:00 ngày đầu tháng hiện tại đến thời điểm gọi API. Khoảng thời gian tối đa 31 ngày. |
| `statuses`   | array\[integer] | Lọc theo trạng thái gửi CAPI.                                                                                                                                                     |
| `orderId`    | string          | Lọc chính xác theo mã đơn hàng/event ID đã lưu.                                                                                                                                   |
| `pageUserId` | string          | Lọc chính xác theo ID khách trên Page/Meta.                                                                                                                                       |
| `adId`       | string          | Lọc chính xác theo Meta Ad ID.                                                                                                                                                    |

### Event hợp lệ

| Giá trị         | Mô tả                          |
| --------------- | ------------------------------ |
| `Purchase`      | Event đơn hàng mua thành công. |
| `LeadSubmitted` | Event khách để lại lead.       |
| `OrderCanceled` | Event đơn hàng bị hủy.         |
| `OrderReturned` | Event đơn hàng hoàn trả.       |

### Status hợp lệ

| Giá trị | Mô tả                                           |
| ------- | ----------------------------------------------- |
| `1`     | Gửi thành công.                                 |
| `2`     | Gửi thất bại.                                   |
| `3`     | Đang gửi.                                       |
| `4`     | Không gửi do điều kiện/cấu hình không thỏa mãn. |

## Response

* Xem cấu trúc chung [tại đây](/v3/readme.md#response).

### Failed response

* Xem các mã lỗi chung [tại đây](/v3/readme.md#failed-response).

### Successful response

```json
{
  "code": 1,
  "data": [
    {
      "id": "Purchase_123456",
      "createdAt": 1787308800,
      "channel": 1,
      "pageId": "123456789",
      "pageUserId": "987654321",
      "adId": "120012345678901",
      "conversationId": "123456789_987654321",
      "eventName": "Purchase",
      "orderId": "123456",
      "orderAmount": 250000,
      "customerShipFee": 30000,
      "sentOrderAmount": 280000,
      "totalAmount": 280000,
      "currency": "VND",
      "status": 1,
      "products": [],
      "dataResponse": {}
    }
  ],
  "paginator": {
    "next": [1787308800, "123456"]
  }
}
```

### Data fields

| Field             | Kiểu           | Mô tả                                            |
| ----------------- | -------------- | ------------------------------------------------ |
| `id`              | string         | ID bản ghi CAPI trong hệ thống.                  |
| `createdAt`       | integer        | Thời điểm tạo event, Unix timestamp theo giây.   |
| `channel`         | integer        | Kênh phát sinh hội thoại/đơn hàng.               |
| `pageId`          | string         | ID Page phát sinh event.                         |
| `conversationId`  | string         | ID hội thoại liên quan, nếu có.                  |
| `eventName`       | string         | Tên CAPI event.                                  |
| `orderId`         | string         | Mã đơn hàng hoặc event ID.                       |
| `orderAmount`     | number         | Tiền hàng của đơn.                               |
| `customerShipFee` | number         | Phí vận chuyển khách trả.                        |
| `totalAmount`     | number         | Tổng tiền đơn: `orderAmount + customerShipFee`.  |
| `sentOrderAmount` | number         | Giá trị đã gửi trong payload CAPI.               |
| `currency`        | string         | Đơn vị tiền tệ.                                  |
| `status`          | integer        | Trạng thái gửi Meta.                             |
| `products`        | array          | Danh sách sản phẩm được lưu cùng event, nếu có.  |
| `dataResponse`    | object\|string | Phản hồi hoặc thông tin lỗi Meta đã lưu, nếu có. |
| `datasetId`       | string         | ID Meta Dataset nhận event, nếu có.              |
| `pageUserId`      | string         | ID khách trên Page/Meta, nếu có.                 |
| `adId`            | string         | Meta Ad ID, nếu event phát sinh từ quảng cáo.    |
| `createdById`     | string         | ID nhân viên/hệ thống tạo event, nếu có.         |