GetLeadsSummary - סיכום מצב לידים
סיכום מצרפי (aggregation) של הלידים לפי טווח תאריכים - סה"כ, פירוט לפי סטטוס, קיבוץ לקבוצות, עלות לליד ושיחות נכנסות. זו הקריאה שעונה על "תן לי תמונת מצב שבועית", לא רשימת לידים. דורשת חבילת Premium/Pro.
בעוד ש-GetLeadIds מחזירה את רשימת הלידים, הקריאה הזו מחזירה סיכום מצרפי של אותם לידים: כמה נכנסו, איך הם מתפלגים לפי סטטוס, כמה נסגרו, מה עלות הליד וכמה שיחות נכנסו. מתאימה בול להודעת "תמונת מצב" שבועית/חודשית ב-Make / Smartsend.
POST https://YOUR-SUBDOMAIN.taskey.co.il/webapi/GetLeadsSummary.php
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
⚠️ חבילה נדרשת:
GetLeadsSummaryזמין בחבילת Premium / Pro. ללא גישה, התשובה תהיהPLAN_UPGRADE_REQUIRED. ראו אימות.
פרמטרים (כולם אופציונליים)
| שדה | תיאור | דוגמה |
|---|---|---|
range | טווח מוכן. ברירת מחדל: last_7_days | last_week |
from / to | טווח מותאם אישית ב-UNIX timestamps (מחליף את range) | 1780000000 |
total_cost | עלות המדיה בטווח - אם מועבר, התשובה כוללת גם עלות ממוצעת לליד | 5000 |
ערכי range אפשריים: this_week, last_week, this_month, last_month, last_7_days, last_30_days. השבוע מתחיל ביום ראשון (לוח ישראלי).
דוגמת בקשה - סיכום השבוע שעבר + עלות מדיה
{
"range": "last_week",
"total_cost": 5000
}
מבנה התשובה
{
"status_code": 200,
"range": { "from": 1783617640, "to": 1786209640, "label": "7 הימים האחרונים" },
"total_leads": 87,
"by_status": [
{ "status_id": 12, "name": "לקוח של משווק", "color": "success", "finish": "", "count": 53 },
{ "status_id": 45, "name": "לא רלוונטי", "color": "danger", "finish": "-1", "count": 15 }
],
"buckets": {
"general": 20,
"in_progress": 30,
"irrelevant": 15,
"closed": 12,
"other": 10
},
"cost_per_lead": { "total_cost": 5000, "per_lead": 57.47 },
"incoming_calls": { "total": 28, "closed": 0 }
}
הסבר השדות
| שדה | משמעות |
|---|---|
range | הטווח שחושב בפועל (from/to ב-UNIX ו-label בעברית להצגה בהודעה) |
total_leads | סה"כ לידים שנכנסו בטווח (Active=1) |
by_status | פירוט לפי כל סטטוס: מזהה, שם, צבע, finish וכמות - ממוין מהגבוה לנמוך |
buckets | קיבוץ גס של כלל הלידים ל-5 קבוצות (סכומם = total_leads) |
cost_per_lead | מוחזר רק אם הועבר total_cost. per_lead = העלות חלקי מספר הלידים |
incoming_calls | מוחזר רק אם קיימות שיחות נכנסות בטווח. closed = מתוכן, כמה קושרו לליד שנסגר |
הקבוצות (buckets)
הקיבוץ נקבע לפי שדה ה-Finish של הסטטוס:
| קבוצה | כוללת |
|---|---|
general | נותרו על סטטוס כללי (חדש / ממתין) |
in_progress | בתהליך / שיחה ראשונה / פגישה |
irrelevant | לא רלוונטים |
closed | סגירות |
other | כל השאר (משלוח / פעיל / העלאה וכו') |
דוגמת cURL מלאה
curl -X POST "https://forte.taskey.co.il/webapi/GetLeadsSummary.php" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"range":"last_week","total_cost":5000}'
💡 רשימה מול סיכום: צריך את הלידים עצמם? השתמשו ב-
GetLeadIds. צריך רק את המספרים לתמונת מצב? זו הקריאה הנכונה.