Assist

استرجاع الجلسات المباشرة

يُرجع قائمة الجلسات المباشرة لمشروع معيّن. يمكن اختياريًا التصفية حسب userId عبر معامل استعلام.

القيم الافتراضية المطبَّقة من جانب الخادم: sort = timestamp، order = desc، limit = 10، page = 1.

الطريقة

GET

URL

/public/:projectKey/assist/sessions

المعاملات

Name	Type	Description
projectKey	string	مفتاح المشروع (مطلوب)
userId	string	قيمة `tracker.setUserID` الاختيارية (معامل استعلام في الـ URL)

ترويسات الطلب

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

مثال على الطلب

curl -X GET \
  '{BASE_URL}/public/aYYaFHiagqdXKEmVlmvJ/assist/sessions?userId=mickael@openreplay.com' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

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

{
  "data": {
    "total": 1,
    "sessions": [
      {
        "pageTitle": "OpenReplay Blog",
        "sessionID": "6975518573799938",
        "metadata": {},
        "userID": "mickael@openreplay.com",
        "userUUID": "8998545b-553c-4f41-a39d-d7cba7fac2d1",
        "projectKey": "aYYaFHiagqdXKEmVlmvJ",
        "timestamp": 1656437966459,
        "trackerVersion": "3.5.11",
        "userOs": "Mac OS",
        "userBrowser": "Chrome",
        "userBrowserVersion": "103.0.0.0",
        "userDeviceType": "desktop",
        "userCountry": "FR",
        "live": true,
        "projectId": 3
      }
    ],
    "live": true
  }
}

البحث في الجلسات المباشرة

ابحث في قائمة الجلسات المباشرة لمشروع معيّن باستخدام جسم طلب بصيغة JSON.

القيم الافتراضية المطبَّقة من جانب الخادم عند حذفها: sort = timestamp، order = desc، limit = 10، page = 1.

الطريقة

POST

URL

/public/:projectKey/assist/sessions

المعاملات

Name	Type	Description
projectKey	string	مفتاح المشروع (مطلوب)

الحمولة (Payload)

Name	Type	Description
sort	string	سمة الترتيب (الافتراضي: `timestamp`)
order	string	`asc` أو `desc` (الافتراضي: `desc`)
page	integer	رقم الصفحة لتقسيم الصفحات (الافتراضي: `1`)
limit	integer	عدد الجلسات في كل صفحة (الافتراضي: `10`)
filters	array of filter	قائمة عوامل التصفية (الافتراضي: `[]`)

كائن عامل التصفية:

Name	Type	Description
name	string	سمة التصفية (مطلوبة، مثل `userId`). استخدم `METADATA` مع `source` أدناه
operator	string	`contains` أو `is` (الافتراضي: `contains`)
value	string[]	قائمة القيم (الافتراضي: `[]`)
source	string	اسم سمة البيانات الوصفية عندما يكون `name = METADATA` (الافتراضي: `""`)

إذا كان value = []، فإن البحث يطابق الجلسات المباشرة التي تم فيها تعيين السمة المحددة (بأي قيمة).

ترويسات الطلب

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

مثال على الطلب

يبحث المثال التالي عن أول 10 جلسات مباشرة (مرتّبة حسب timestamp تنازليًا) حيث يحتوي userId على openreplay وتكون metadata.plan مساوية لـ trial أو free.

curl -X POST \
  {BASE_URL}/public/aYYaFHiagqdXKEmVlmvJ/assist/sessions \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "filters": [
      { "value": ["trial", "free"], "name": "METADATA", "source": "plan", "operator": "is" },
      { "value": ["openreplay"], "name": "userId", "operator": "contains" }
    ],
    "sort": "timestamp",
    "order": "desc",
    "limit": 10,
    "page": 1
  }'

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

{
  "data": {
    "total": 1,
    "sessions": [
      {
        "pageTitle": "OpenReplay Blog",
        "sessionID": "6975518573799185",
        "metadata": { "plan": "trial" },
        "userID": "dev@openreplay.com",
        "userUUID": "8998545b-553c-4f41-a39d-d7cba7fac2d1",
        "projectKey": "aYYaFHiagqdXKEmVlmvJ",
        "timestamp": 1656437966459,
        "trackerVersion": "3.5.11",
        "userOs": "Mac OS",
        "userBrowser": "Chrome",
        "userBrowserVersion": "103.0.0.0",
        "userDeviceType": "desktop",
        "userCountry": "FR",
        "live": true,
        "projectId": 3
      }
    ],
    "live": true
  }
}