الأحداث

كيفية جلب جميع الأحداث الخاصة بتسجيل محدد.

الأحداث

يُرجِع قائمة الأحداث (النقرات، زيارات الصفحات، الإدخالات، الأحداث المخصصة، وما إلى ذلك) الملتقطة في جلسة محددة. يفرض الخادم نطاق الجلسة — حيث تتم إضافة معامِل المسار sessionID تلقائيًا كمرشِّح للأحداث.

POST

/public/:projectKey/sessions/:sessionId/events

الاسمالنوعالوصف
projectKeystringمفتاح المشروع (مطلوب)
sessionIdstringمعرّف الجلسة (مطلوب، 256 كحد أقصى)
الاسمالنوعالوصف
startTimestampepoch (ms)بداية النافذة الزمنية (مطلوب، 946684800000 كحد أدنى)
endTimestampepoch (ms)نهاية النافذة الزمنية (مطلوب، > startTimestamp)
limitintegerحجم الصفحة، 1-200 (مطلوب)
pageintegerرقم الصفحة، يبدأ من 1 (مطلوب)
sortBystringعمود الحدث المستخدَم للترتيب (اختياري)
sortOrderstringasc أو desc (اختياري)
filtersarrayمرشِّحات أحداث إضافية (اختياري) — انظر بنية المرشِّح أدناه
columnsarrayأعمدة الأحداث المراد تضمينها في الاستجابة (اختياري)

كائن المرشِّح:

الاسمالنوعالوصف
namestringاسم سمة المرشِّح (مطلوب، 256 كحد أقصى)
operatorstringعامل المقارنة (مثل is، contains)
valuestring[]حتى 10 قيم، كل منها 256 حرفًا كحد أقصى
isEventbooleanما إذا كان المرشِّح يستهدف خاصية حدث
dataTypestringأحد القيم string، number، boolean، integer، timestamp

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200 تُرسَل الاستجابة بصيغة JSON في النص
400 نص غير صالح أو sessionID غير صالح (فارغ أو > 256 حرفًا)

curl -X POST \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/sessions/4813023023591169/events \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "startTimestamp": 1623440000000,
    "endTimestamp":   1623441000000,
    "limit": 100,
    "page":  1,
    "sortOrder": "asc"
  }'

مثال على الاستجابة

Section titled مثال على الاستجابة
{
  "data": {
    "total": 3,
    "events": [
      {
        "event_id": "01H7Z...",
        "$event_name": "$pageview",
        "created_at": 1623440905732,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "properties": { "path": "/my-account/" }
      },
      {
        "event_id": "01H7Z...",
        "$event_name": "$click",
        "created_at": 1623440915126,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "$properties": { "label": "Shop" },
        "$auto_captured": true
      }
    ]
  }
}