דלג לתוכן הראשי

API לאנליטיקה

ה־API של האנליטיקה מספק גישה תכנותית ליכולות אנליטיקת מוצר, ובהן שאילתות אירועים, משפכים, ניתוח שימור, ניתוח נתיבים ו־Cohorts.

כל נקודות הקצה בעמוד זה יחסיות לכתובת הבסיס: https://api-eu1.joryio.com - ראו סקירת API.

אימות​

כל נקודות הקצה דורשות אימות באמצעות מפתח API:

Authorization: Bearer YOUR_API_KEY
X-Workspace-Id: YOUR_WORKSPACE_ID

סייר אירועים​

רשימת אירועים​

מחזיר סיכום של כל האירועים שנמדדו.

GET /analytics/events

פרמטרי שאילתה:

פרמטרסוגתיאור
startDatestringתאריך התחלה (YYYY-MM-DD)
endDatestringתאריך סיום (YYYY-MM-DD)
searchstringסינון לפי שם אירוע
limitnumberמספר התוצאות המרבי (ברירת מחדל: 100)

תגובה:

{
  "events": [
    {
      "eventName": "signup_completed",
      "totalCount": 15420,
      "uniqueUsers": 12350,
      "lastSeen": "2024-01-15T14:30:00Z"
    }
  ],
  "total": 45
}

מגמת אירועים​

מחזיר ספירות אירועים לאורך זמן.

POST /analytics/events/trend

גוף בקשה:

{
  "eventNames": ["signup_completed", "purchase_completed"],
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "timeGranularity": "day"
}

תגובה:

[
  {
    "date": "2024-01-01",
    "count": 523,
    "uniqueUsers": 498
  }
]

מאפייני אירוע​

רשימת המאפיינים של אירוע ספציפי.

GET /analytics/events/:eventName/properties

תגובה:

[
  {
    "propertyName": "plan_type",
    "valueCount": 4
  },
  {
    "propertyName": "source",
    "valueCount": 12
  }
]

פילוח לפי מאפיין​

מחזיר את התפלגות הערכים של מאפיין אירוע.

POST /analytics/events/property-breakdown

גוף בקשה:

{
  "eventName": "purchase_completed",
  "property": "payment_method",
  "startDate": "2024-01-01",
  "endDate": "2024-01-31"
}

תגובה:

{
  "total": 5420,
  "values": [
    { "value": "credit_card", "count": 3250, "percentage": 59.96 },
    { "value": "paypal", "count": 1520, "percentage": 28.04 },
    { "value": "bank_transfer", "count": 650, "percentage": 11.99 }
  ]
}

ניתוח משפכים​

יצירת משפך​

שומר הגדרת משפך חדשה.

POST /analytics/funnels

גוף בקשה:

{
  "name": "Signup to Purchase",
  "steps": [
    {
      "id": "step_1",
      "order": 0,
      "eventName": "signup_completed",
      "filters": []
    },
    {
      "id": "step_2",
      "order": 1,
      "eventName": "onboarding_completed",
      "filters": []
    },
    {
      "id": "step_3",
      "order": 2,
      "eventName": "purchase_completed",
      "filters": []
    }
  ],
  "conversionWindowDays": 7
}

רשימת משפכים​

GET /analytics/funnels

ניתוח משפך​

מריץ ניתוח של משפך שמור.

POST /analytics/funnels/:id/analyze

גוף בקשה:

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "breakdown": {
    "type": "event_property",
    "property": "utm_source"
  }
}

תגובה:

{
  "totalUsers": 10000,
  "overallConversion": 12.5,
  "steps": [
    {
      "id": "step_1",
      "order": 0,
      "eventName": "signup_completed",
      "enteredCount": 10000,
      "conversionRate": 100,
      "dropOffRate": 0
    },
    {
      "id": "step_2",
      "order": 1,
      "eventName": "onboarding_completed",
      "enteredCount": 6500,
      "conversionRate": 65,
      "dropOffRate": 35
    },
    {
      "id": "step_3",
      "order": 2,
      "eventName": "purchase_completed",
      "enteredCount": 1250,
      "conversionRate": 19.23,
      "dropOffRate": 80.77
    }
  ],
  "breakdown": [
    {
      "breakdownValue": "google",
      "overallConversion": 15.2,
      "steps": [...]
    }
  ]
}

ניתוח משפך מהיר​

ניתוח ללא שמירה.

POST /analytics/funnels/quick-analyze

ניתוח שימור​

ניתוח שימור​

POST /analytics/retention/analyze

גוף בקשה:

{
  "startEvent": "signup_completed",
  "returnEvent": "session_started",
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "timeUnit": "week",
  "periods": 8
}

תגובה:

{
  "timeUnit": "week",
  "cohorts": [
    {
      "cohortDate": "2024-01-01",
      "cohortSize": 1250,
      "periods": [
        { "period": 0, "retainedCount": 1250, "retentionRate": 100 },
        { "period": 1, "retainedCount": 562, "retentionRate": 44.96 },
        { "period": 2, "retainedCount": 375, "retentionRate": 30.0 }
      ]
    }
  ],
  "overallRetention": [100, 45.2, 31.5, 25.8, 22.1, 19.5, 17.8, 16.2]
}

ייצוא שימור​

POST /analytics/retention/export

מחזיר נתוני CSV.

ניתוח נתיבים​

ניתוח נתיבים​

POST /analytics/paths/analyze

גוף בקשה:

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "startEvent": "landing_page_view",
  "direction": "forward",
  "maxSteps": 5,
  "minPathCount": 10,
  "minPathPercent": 0.5,
  "maxBranchesPerStep": 5,
  "excludeEvents": ["heartbeat", "scroll"]
}

תגובה:

{
  "totalUsers": 25000,
  "totalPaths": 342,
  "paths": [
    {
      "path": ["landing_page_view", "signup_started", "signup_completed"],
      "count": 3250,
      "percentage": 13.0
    }
  ],
  "sankey": {
    "nodes": [
      { "id": "landing_page_view_0", "name": "landing_page_view" }
    ],
    "links": [
      { "source": "landing_page_view_0", "target": "signup_started_1", "value": 5200 }
    ]
  }
}

Cohorts​

יצירת Cohort​

POST /analytics/cohorts

גוף בקשה:

{
  "name": "Power Users",
  "description": "Users who engage frequently",
  "rules": [
    {
      "type": "event",
      "operator": "did_count",
      "eventName": "session_started",
      "count": 10,
      "timeWindow": { "value": 30, "unit": "day" }
    }
  ]
}

רשימת Cohorts​

GET /analytics/cohorts

קבלת Cohort​

GET /analytics/cohorts/:id

עדכון Cohort​

PUT /analytics/cohorts/:id

מחיקת Cohort​

DELETE /analytics/cohorts/:id

רענון הספירה של Cohort​

POST /analytics/cohorts/:id/refresh

יצירת סגמנט מתוך Cohort​

מקשר Cohort לסגמנט לצורך מיקוד קמפיינים.

POST /analytics/cohorts/:id/create-segment

גוף בקשה:

{
  "segmentName": "Power Users Segment"
}

לוחות בקרה​

יצירת לוח בקרה​

POST /analytics/dashboards

גוף בקשה:

{
  "name": "Executive Dashboard",
  "description": "Key metrics overview",
  "widgets": [
    {
      "id": "widget-1",
      "type": "metric",
      "title": "Active Users",
      "config": {
        "eventName": "session_started",
        "metric": "unique_users"
      },
      "layout": { "x": 0, "y": 0, "width": 3, "height": 2 }
    }
  ]
}

רשימת לוחות בקרה​

GET /analytics/dashboards

קבלת לוח בקרה​

GET /analytics/dashboards/:id

עדכון לוח בקרה​

PUT /analytics/dashboards/:id

מחיקת לוח בקרה​

DELETE /analytics/dashboards/:id

אנליטיקה בזמן אמת​

משתמשים פעילים​

GET /analytics/realtime/active-users

תגובה:

{
  "count": 1523,
  "trend": 5.2
}

זרם אירועים חי (SSE)​

GET /analytics/realtime/events/stream

מחזיר זרם Server-Sent Events של אירועים חיים.

תגובות שגיאה​

כל נקודות הקצה מחזירות תגובות שגיאה סטנדרטיות:

{
  "statusCode": 400,
  "message": "Invalid date range",
  "error": "Bad Request"
}
קוד סטטוסתיאור
400בקשה שגויה / שגיאת תיקוף
401לא מורשה
403גישה אסורה
404משאב לא נמצא
500שגיאת שרת פנימית