مرجع api / leads/get-count/

شمارش سرنخ‌های مطابق با فیلتر

تعداد سرنخ‌های مطابق با مجموعه فیلتر را برمی‌گرداند، بدون افشای داده‌ها. این اندپوینت رایگان است؛ از آن برای پیش‌نمایش حجم نتایج پیش از خرید استفاده کنید.

POSTleads/get-count/

تعداد سرنخ‌های مطابق با مجموعه فیلتر را برمی‌گرداند، بدون افشای داده‌ها. این endpoint رایگان است و راه ایده‌آل برای پیش‌نمایش حجم نتایج پیش از فراخوانی پولی leads/get-records/ محسوب می‌شود.

رایگان20 درخواست در دقیقه

هدرها

X-API-KEYstringبله

کلید api شما.

Content-Typestringبله
default: application/json

باید برابر application/json باشد.

بدنه درخواست

filtersFilter[]بله

آرایه‌ای از اشیاء فیلتر، هر کدام شامل { key, operand, value }. key از پاسخ leads/fields/ گرفته می‌شود، operand یکی از supported_operands آن فیلد، و value یا یک مقدار اسکالر یا آرایه (بسته به operand) است.

نمونه درخواست

curl -X POST 'https://saravar.com/api/leads/get-count/' \
-H 'X-API-KEY: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"filters": [
{ "key": "city_of_residence", "operand": "in", "value": [1, 5, 12] },
{ "key": "gender", "operand": "equals", "value": 2 }
]
}'

پاسخ

countintegerبله

تعداد سرنخ‌های مطابق با مجموعه فیلتر.

خطاها

400کد وضعیت
علتفیلتر نامعتبر است: کلید فیلد ناشناخته، operand مجاز نیست، یا value با نوع فیلد سازگار نیست.
اقدام پیشنهادیفیلتر را با schema بازگشتی از leads/fields/ مطابقت دهید. عملگرهای مجاز در supported_operands فهرست شده‌اند.
401کد وضعیت
علتکلید api نامعتبر است.
اقدام پیشنهادیکلید فعال در داشبورد بسازید.
429کد وضعیت
علتاز سقف نرخ کلید عبور کرده‌اید.
اقدام پیشنهادیتا انقضای Retry-After صبر کنید.