API Reference — Events Ingestion
API Reference — Meters Creation
Tạo một đồng hồ đo
Các đồng hồ đo xác định cách các sự kiện sử dụng của bạn được tổng hợp và đo lường cho mục đích thanh toán. Trước khi tạo một đồng hồ đo, hãy lập kế hoạch chiến lược theo dõi mức sử dụng của bạn:- Xác định các sự kiện sử dụng mà bạn muốn theo dõi
- Xác định cách các sự kiện nên được tổng hợp (đếm, tổng, v.v.)
- Định nghĩa bất kỳ yêu cầu lọc nào cho các trường hợp sử dụng cụ thể
Quy trình tạo đồng hồ đo từng bước
Làm theo hướng dẫn này để thiết lập usage meter của bạn:Configure Basic Information
Configure Aggregation Settings
- Count
- Sum
- Max
- Last
Configure Event Filtering (Optional)
- AND Logic
- OR Logic
user_tier = "premium" AND endpoint = "/api/v2/users"Add Condition
Configure Property Key
Select Comparator
equals— Khớp chính xácnot_equals— Bộ lọc loại trừgreater_than— So sánh sốgreater_than_or_equals— So sánh số (bao gồm cả giá trị biên)less_than— So sánh sốless_than_or_equals— So sánh số (bao gồm cả giá trị biên)contains— Chuỗi chứa chuỗi condoes_not_contain— Bộ lọc loại trừ chuỗi
Set Comparison Value
Add Groups
Create Meter
Liên kết Meter trong Product
Sau khi tạo meter, bạn cần liên kết meter đó với một product để bật tính phí dựa trên mức sử dụng. Quy trình này kết nối dữ liệu sử dụng từ meter với các quy tắc định giá để tính phí cho khách hàng. Việc liên kết meter với product thiết lập mối liên hệ giữa theo dõi mức sử dụng và tính phí:- Product xác định các quy tắc định giá và hành vi tính phí
- Meter cung cấp dữ liệu sử dụng cho các phép tính tính phí
- Có thể liên kết nhiều meter với một product để xử lý các tình huống tính phí phức tạp
Quy trình cấu hình Product
Chuyển đổi dữ liệu sử dụng thành các khoản phí có thể tính bằng cách cấu hình đúng các cài đặt product:Choose Usage-Based Billing Product Type
Select Associated Meter
Add Your Meter
- Nhấp vào Add Meters để xem các meter hiện có
- Chọn meter bạn đã tạo từ danh sách thả xuống
- Meter đã chọn sẽ xuất hiện trong cấu hình product
Configure Price Per Unit
- Đã sử dụng 1.000 đơn vị = 1.000 × $0.50 = tính phí $500.00
- Đã sử dụng 500 đơn vị = 500 × $0.50 = tính phí $250.00
- Đã sử dụng 100 đơn vị = 100 × $0.50 = tính phí $50.00
Set Free Threshold (Optional)
- Hạn mức miễn phí: 100 đơn vị
- Giá mỗi đơn vị: $0.50
- Mức sử dụng của khách hàng: 250 đơn vị
- Phép tính: (250 - 100) × $0.50 = tính phí $75.00
Save Configuration
- Các sự kiện sử dụng được gửi đến meter sẽ được theo dõi và tổng hợp
- Các phép tính tính phí sẽ tự động áp dụng quy tắc định giá của bạn
- Khách hàng sẽ bị tính phí dựa trên mức tiêu thụ thực tế trong mỗi chu kỳ tính phí
Gửi sự kiện sử dụng
Sau khi cấu hình meter, bạn có thể bắt đầu gửi các sự kiện sử dụng từ ứng dụng để theo dõi mức sử dụng của khách hàng.Cấu trúc sự kiện
Mỗi sự kiện sử dụng phải bao gồm các field bắt buộc sau:Ví dụ về Usage Events API
Gửi các sự kiện sử dụng đến meter đã cấu hình bằng Events API:Những điều quan trọng cần biết để nhập dữ liệu đáng tin cậy
Làm theo các phương pháp này để duy trì việc theo dõi mức sử dụng chính xác và bền vững trong production.timestamp đối với các sự kiện real-time; giá trị này sẽ mặc định là timestamp UTC hiện tại. Thiết lập rõ ràng giá trị này (theo ISO 8601) cho các sự kiện bị trì hoãn hoặc gửi theo batch để mức sử dụng được ghi nhận vào đúng kỳ tính phí. Lưu ý rằng khoảng thời gian được chấp nhận khá hẹp: các sự kiện có timestamp quá 1 giờ trong quá khứ hoặc hơn 5 phút trong tương lai sẽ bị từ chối. Không hỗ trợ backfill dữ liệu lịch sử — hãy gửi các sự kiện đang được đệm trong vòng một giờ.Phân tích tính phí dựa trên mức sử dụng
Theo dõi và phân tích dữ liệu tính phí dựa trên mức sử dụng bằng dashboard analytics toàn diện. Theo dõi mô hình tiêu thụ của khách hàng, hiệu suất meter và xu hướng tính phí để tối ưu chiến lược định giá và hiểu hành vi sử dụng.Phân tích tổng quan
Tab Overview cung cấp góc nhìn toàn diện về hiệu suất tính phí dựa trên mức sử dụng:Chỉ số hoạt động
Theo dõi các thống kê sử dụng chính trong nhiều khoảng thời gian khác nhau:Biểu đồ số lượng Meter

- Trực quan hóa chuỗi thời gian: Theo dõi mô hình sử dụng theo ngày, tuần hoặc tháng
- Hỗ trợ nhiều meter: Xem dữ liệu từ các meter khác nhau đồng thời
- Phân tích xu hướng: Xác định các đợt tăng đột biến, mô hình và quỹ đạo tăng trưởng của mức sử dụng
Phân tích sự kiện

Hiển thị thông tin sự kiện
Bảng sự kiện cung cấp chế độ xem rõ ràng về từng sự kiện sử dụng với các cột sau:- Event Name: Hành động hoặc trigger cụ thể tạo ra sự kiện sử dụng
- Event ID: Mã định danh duy nhất cho mỗi instance của sự kiện
- Customer ID: Khách hàng liên kết với sự kiện
- Timestamp: Thời điểm sự kiện xảy ra
Phân tích khách hàng
Tab Customers cung cấp chế độ xem dạng bảng chi tiết về dữ liệu sử dụng của khách hàng với các thông tin sau:Các cột dữ liệu hiện có
Tính năng của bảng
- Filtering cột: Sử dụng tính năng “Edit Columns” để hiển thị hoặc ẩn các cột dữ liệu cụ thể
- Cập nhật theo thời gian thực: Dữ liệu sử dụng phản ánh các chỉ số tiêu thụ mới nhất
Ví dụ về tổng hợp
Dưới đây là các ví dụ thực tế về cách hoạt động của những loại tổng hợp khác nhau:Tìm hiểu các loại tổng hợp
Các loại tổng hợp khác nhau phục vụ những tình huống tính phí khác nhau. Chọn loại phù hợp dựa trên cách bạn muốn đo lường và tính phí cho mức sử dụng.Ví dụ triển khai thực tế
Các ví dụ này minh họa những ứng dụng thực tế của từng loại tổng hợp bằng các sự kiện mẫu và kết quả dự kiến:Count Aggregation — API Calls
Count Aggregation — API Calls
- Event Name:
api.call - Aggregation Type: Count
- Measurement Unit:
calls
Sum Aggregation — Data Transfer
Sum Aggregation — Data Transfer
- Event Name:
data.transfer - Aggregation Type: Sum
- Over Property:
bytes - Measurement Unit:
GB
Max Aggregation — Peak Concurrent Users
Max Aggregation — Peak Concurrent Users
- Event Name:
concurrent.users - Aggregation Type: Max
- Over Property:
count - Measurement Unit:
users
Ví dụ về filtering sự kiện
- Filter by API Endpoint
- Filter by Value Range
- Complex Multi-Condition Filters
- Property:
endpoint - Comparator:
equals - Value:
/v1/orders
Khắc phục sự cố
Giải quyết các vấn đề phổ biến trong quá trình triển khai tính phí dựa trên mức sử dụng và đảm bảo việc theo dõi cũng như tính phí chính xác.Các vấn đề phổ biến
Hầu hết vấn đề về tính phí dựa trên mức sử dụng thuộc các nhóm sau:- Vấn đề gửi và xử lý sự kiện
- Vấn đề cấu hình meter
- Lỗi kiểu dữ liệu và định dạng
- Vấn đề Customer ID và authentication
Các bước debugging
Khi khắc phục sự cố về tính phí dựa trên mức sử dụng:- Xác minh việc gửi sự kiện trong tab Events analytics
- Kiểm tra để bảo đảm cấu hình meter khớp với cấu trúc sự kiện
- Xác thực Customer ID và API authentication
- Xem lại điều kiện filtering và cài đặt aggregation
Giải pháp và cách khắc phục
Events not showing in meter
Events not showing in meter
- Tên sự kiện không khớp chính xác với cấu hình meter
- Điều kiện filtering sự kiện đang loại trừ các sự kiện của bạn
- Customer ID không tồn tại trong tài khoản Dodo Payments của bạn
- Timestamp của sự kiện nằm ngoài kỳ tính phí hiện tại
- Xác minh chính tả và phân biệt chữ hoa chữ thường của tên sự kiện
- Xem lại và kiểm thử các điều kiện filtering
- Xác nhận Customer ID hợp lệ và đang hoạt động
- Kiểm tra để bảo đảm timestamp của sự kiện là gần đây và được định dạng đúng
Aggregation not working as expected
Aggregation not working as expected
- Tên Over Property không khớp với các key metadata của sự kiện
- Giá trị metadata có kiểu dữ liệu không đúng (string thay vì number)
- Thiếu các property metadata bắt buộc
- Đảm bảo các key metadata khớp chính xác với cài đặt Over Property
- Chuyển đổi số dạng string thành number thực tế trong các sự kiện
- Bao gồm tất cả property bắt buộc trong mỗi sự kiện
Filtering not working
Filtering not working
- Tên property filter không khớp với metadata của sự kiện
- Comparator không phù hợp với kiểu dữ liệu (string thay vì number)
- Phân biệt chữ hoa chữ thường trong các phép so sánh chuỗi
- Kiểm tra kỹ để bảo đảm tên property khớp chính xác
- Sử dụng comparator phù hợp với kiểu dữ liệu
- Lưu ý đến việc phân biệt chữ hoa chữ thường khi filtering chuỗi