Chuyển đến nội dung chính
GET
Lấy tất cả các profile liên kết với primary profile. Primary Profile không được trả về trong kết quả. Vì lý do bảo mật, Profile Key không được trả về qua lệnh gọi GET này. Vui lòng xem tại đây để biết thêm thông tin.

Tham số Header

Tham số Query

title
string
Chỉ trả về profile liên kết với tiêu đề được mã hóa URL.
refId
string
Chỉ trả về profile liên kết với refId đã cho. refId được trả về trong quá trình tạo profile hoặc từ endpoint /user.
hasActiveSocialAccounts
boolean
mặc định:false
Nếu true, chỉ trả về các profile có ít nhất một social account đã kết nối (độ dài activeSocialAccounts lớn hơn không). Nếu false, chỉ trả về các profile có không có social account đã kết nối (độ dài activeSocialAccounts bằng không).
includesActiveSocialAccounts
array
Lọc các profile để bao gồm những profile có activeSocialAccounts chứa tất cả các nền tảng mạng xã hội được chỉ định trong danh sách includesActiveSocialAccounts. Các profile có thể có thêm các nền tảng khác trong activeSocialAccounts của họ ngoài những nền tảng được liệt kê trong includesActiveSocialAccounts và vẫn được bao gồm trong kết quả đã lọc.Giá trị: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.
isByokLinked
boolean
Lọc profile theo trạng thái di chuyển BYOK (Bring Your Own Key). Nếu true, chỉ trả về các profile đã hoàn thành di chuyển BYOK. Nếu false, chỉ trả về các profile có nền tảng đủ điều kiện BYOK được kết nối nhưng chưa di chuyển. Các profile không có nền tảng đủ điều kiện BYOK sẽ bị loại trừ khi bộ lọc này được đặt. Khi bị bỏ qua, tất cả các profile được trả về bất kể trạng thái BYOK. Hiện tại áp dụng cho X/Twitter BYOK.
actionLog
boolean
mặc định:false
Trả về nhật ký hành động tạo và xóa User Profile trong 60 ngày qua và số lượng người dùng đang hoạt động được sử dụng để tính hóa đơn cho 60 ngày qua. Lưu ý:
  • Action Log: Tiêu đề và tags sẽ không được trả về cho lịch sử action log trước tháng 3 năm 2025.
  • Báo cáo User Profile: Khoảng thời gian có thể không tương ứng với chu kỳ thanh toán của bạn. Ví dụ, chu kỳ thanh toán của bạn có thể bắt đầu và kết thúc vào ngày 10 mỗi tháng. Vui lòng xem các hóa đơn của bạn để biết chu kỳ thanh toán và các chi tiết khác.
Bạn có thể chỉ định khoảng thời gian khác bằng cách đặt actionLog thành số ngày. Ví dụ, tham số truy vấn actionLog=10 sẽ trả về action log trong 10 ngày qua và số lượng người dùng đang hoạt động được báo cáo cho 10 ngày qua. Khoảng thời gian cho phép là 1 ngày đến 365 ngày.
limit
number
mặc định:5000
Giới hạn số lượng profile được trả về. Mặc định và tối đa là 5000.
cursor
string
Nếu có thêm profile để trả về và cờ hasMoretrue, nextCursor sẽ được trả về trong phản hồi. Truyền con trỏ này vào tham số truy vấn cursor để trả về bộ profile tiếp theo.
include
string | array
Trả về dữ liệu profile mở rộng để khắc phục sự cố. Yêu cầu tham số refId (tra cứu một profile).Giá trị (chuỗi phân tách bằng dấu phẩy hoặc mảng): suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog.
  • suspension - isSuspended, reason, suspendedAt, unsuspendAt, suspensionCount
  • socialHealth - Theo từng nền tảng: linked, linkedAt, relinkRecommended, messagingEnabled, tokenExpiresAt
  • linkingErrors - Theo từng nền tảng: code, message, details, createdAt
  • activity - Dấu thời gian lastApiCall, lastPost
  • quota - used, limit
  • unlinkHistory - Lần hủy liên kết cuối cùng: platform, source (user/system), details, createdAt
  • actionLog - Lịch sử hành động profile (create/update/delete)