אנליטיקס
שליפת Pipeline
POST
/api/v1/webhookקבלת נתוני Pipeline של ישות: חלוקת רשומות לפי שלבים (סטטוסים), ממוינים לפי כמות. שימושי לבניית דשבורד מכירות.
אימות
Authorizationstringheaderחובהכותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.
פרמטרים
entitystringחובההslug של הישות
statusFieldstringשם שדה הסטטוס (ברירת מחדל: status)
תשובה
200 — application/json
successbooleanחובהמציין אם הבקשה הצליחה
dataobjectאובייקט המכיל את נתוני התשובה
שליפת Pipeline
const response = await fetch('https://crm.heybase.co.il/api/v1/webhook', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": "get_pipeline",
"entity": "deals",
"statusField": "status"
}),
})
const data = await response.json()200
{
"success": true,
"data": {
"entity": "deals",
"statusField": "status",
"total": 142,
"stages": [
{
"stage": "בטיפול",
"count": 48
},
{
"stage": "הצעת מחיר",
"count": 32
},
{
"stage": "ליד חדש",
"count": 25
},
{
"stage": "נסגר בהצלחה",
"count": 18
},
{
"stage": "סגירה",
"count": 15
},
{
"stage": "אבוד",
"count": 4
}
]
}
}בעמוד זה
