Phân trang

Tham chiếu

Dành cho:: Nhà phát triển

Cách phân trang REST API trong ReputeCast tùy theo từng danh sách: phần lớn danh sách nhận page và pageSize, nhật ký và luồng hoạt động nhận cursor, còn một số ít nhận thời điểm hoặc offset. Trang của mỗi thao tác trong tài liệu API ghi rõ tham số của nó; trang này nhóm chúng theo kiểu. Danh sách trong phản hồi không bao giờ là null: danh sách rỗng là [].

Danh sách theo trang: `page` và `pageSize`

Gửi page (bắt đầu từ 1, mặc định 1) và pageSize. Phản hồi có items, total (số mục khớp với bộ lọc của bạn), page và pageSize, thường đi kèm các trường tổng hợp như counts.

curl -s -H "Authorization: Bearer $RC_KEY" \
  "$RC_URL/api/v1/workspaces/acme-newsletter/campaigns?status=sent&page=2&pageSize=50"

Bạn đã có đủ mọi mục khi page × pageSize ≥ total.
Một trang nằm quá cuối danh sách trả về 200 với "items": [].
Gửi cùng bộ lọc ở mọi trang.

Thao tác	`pageSize` mặc định	`pageSize` lớn nhất
`list-campaigns`	25	100
`list-contacts`	10	100
`list-suppressions`	10	100
`list-provider-events`	25	100
`list-product-orders`	10	100
`list-paid-members`	8	100
`list-payment-events`	8	100

Một vài danh sách chỉ nhận page và tự chọn kích thước trang: list-gifts (20 quà tặng mỗi trang), list-referrers, get-partner-requests, list-sms-suppressions và list-sms-events.

Danh sách theo cursor: `cursor` và `limit`

Gửi limit, rồi truyền cursor từ phản hồi trước làm cursor để lấy trang tiếp theo. Cursor là giá trị không cần hiểu nội dung: hãy lưu nguyên như nhận được. Ở trang cuối, trường cursor bị bỏ khỏi phản hồi.

curl -s -H "Authorization: Bearer $RC_KEY" \
  "$RC_URL/api/v1/workspaces/acme-newsletter/audit?limit=200&cursor=<nextCursor from the previous page>"

Thao tác	Trường cursor trong phản hồi	`limit` mặc định	`limit` lớn nhất
`list-audit-events`	`nextCursor`, kèm `total`	50	200
`contact-activity`	`nextCursor`, kèm `total`	8	100
`list-ai-activity`	`next`	50	100
`list-store-activity`	`next`	25	100
`list-store-products`	`next` (một số), kèm `total`	48	100

Danh sách theo thời gian: `before` và `limit`

Các nhật ký tiếp tục tăng trong lúc bạn đọc được phân trang lùi theo thời gian, mới nhất trước.

Thao tác	Cách lấy trang tiếp theo	`limit` mặc định	`limit` lớn nhất
`list-transactional-messages`	Truyền `next` của phản hồi làm `before`	25	100
`list-conversions`	Truyền `next` (một thời điểm) của phản hồi làm `before`	50	200
`list-whatsapp-events`	Truyền `next` (một thời điểm) của phản hồi làm `before`	50	200
`list-push-events`	Khi `more` là `true`, truyền thời điểm của sự kiện cuối cùng làm `before`	50	200

list-transactional-messages còn nhận after: truyền giá trị newest của một trang để chỉ lấy những thư đến sau đó, phục vụ chế độ xem trực tiếp.

Danh sách theo offset: `offset` và `limit`

Gửi offset (số mục cần bỏ qua, bắt đầu từ 0) và limit.

Thao tác	`limit` mặc định	`limit` lớn nhất
`list-integration-calls`	20	100 (`offset` tối đa 10.000)
`list-poll-comments`	20	100
`list-survey-responses`	20	100
`list-survey-text-answers`	20	100
`list-sms-replies`	50	100

Danh sách chỉ có `limit`

Những danh sách này trả về tối đa limit mục và không có trang tiếp theo: list-webhook-deliveries (50, tối đa 200), list-media (200, tối đa 500), list-campaign-versions (50, tối đa 300) và list-agent-actions (20, tối đa 100). Những danh sách hoàn toàn không nhận tham số phân trang, như list-lists và list-segments, trả về mọi mục cùng lúc.

Ghi chú

Giá trị vượt mức lớn nhất cho phép trả về 422 với mã validation_failed và tham số đó trong errors[].location, ví dụ query.pageSize (xem lỗi API).
Mỗi trang được tính là một yêu cầu theo giới hạn tốc độ. Hãy yêu cầu trang lớn nhất bạn dùng được thay vì nhiều trang nhỏ.
Để theo dõi thay đổi mà không phải duyệt lại danh sách, hãy nhận webhook.

Phân trang

Danh sách theo trang: page và pageSize

Danh sách theo cursor: cursor và limit

Danh sách theo thời gian: before và limit

Danh sách theo offset: offset và limit

Danh sách chỉ có limit