အများသုံး API & API သော့များ

အလုပ်နေရာသို့ ပရိုဂရမ်ဖြင့် ဝင်ရောက်ခွင့် — ပရောဂျက်၊ ဆက်ရှင်၊ စိတ်ကြိုက်ဖြစ်ရပ်နှင့် အုပ်စုခွဲများ ဖတ်ပြီး ဆက်ရှင်များသို့ ဖောက်သည် ID တွဲနိုင်သည် — အလုပ်နေရာနယ်ပယ်ကန့်သတ် API သော့များဖြင့် ကာကွယ်ထားသည်။

1. အကျဉ်းချုပ်

MousePlayer API သည် အလုပ်နေရာမှ ဒေတာကို ကိုယ်ပိုင်ဒက်ရှ်ဘုတ်၊ ဒေတာသိုလှောင်ရုံ သို့မဟုတ် အတွင်းကိရိယာများထဲ ရယူနိုင်စေသည်။ ဆက်ရှင်သို့ ဖောက်သည် ID တွဲခြင်း (identify၊ ရေးနယ်ပယ်ပါသော့ လိုသည်၊ သော့နယ်ပယ်များတွင် ကြည့်ပါ) မှလွဲ၍ ၎င်းသည် ဖတ်ရန်သာဖြစ်သည်: API မှ ဒေတာပြင် သို့မဟုတ် ဖျက်၍မရပါ။

အခြေခံ URL: https://www.mouseplayer.com/api/v1/
တုံ့ပြန်ချက်အားလုံး JSON ဖြစ်သည်။
တောင်းဆိုမှုတိုင်းကို API သော့ဖြင့် အတည်ပြုပြီး ထိုသော့နှင့်သက်ဆိုင်သော အလုပ်နေရာသို့ အလိုအလျောက်ကန့်သတ်သည် — အလုပ်နေရာတစ်ခုမှ သော့သည် အခြားအလုပ်နေရာဒေတာကို မတော်တဆပင် လုံးဝမမြင်နိုင်ပါ။
ဆက်ရှင်ပြန်ဖွင့်မှတ်တမ်းအပြည့် (မောက်စ်ရွေ့လျားမှု၊ DOM ပုံရိပ်များ) ကို API မှ လုံးဝမပေးပါ ။ ဆက်ရှင်မီတာဒေတာ၊ စာမျက်နှာကြည့်မှု၊ စိတ်ကြိုက်ဖြစ်ရပ်နှင့် အုပ်စုခွဲများ ရသည် — ဒေတာအကြမ်းပြန်ဖွင့်အထုပ်ကို နေရာတကာမပို့ဘဲ အစီရင်ခံစာနှင့် ဒက်ရှ်ဘုတ် တည်ဆောက်ရန် လုံလောက်သည်။

2. အထောက်အထားအတည်ပြုခြင်း

API သော့များကို ဖန်တီးစီမံရာနေရာမှာ API သော့များ ဖြစ်ပြီး အကောင့်မီနူးတွင် ရှိသည် (/api-keys)။ အလုပ်နေရာပိုင်ရှင်နှင့် စီမံခန့်ခွဲသူများသာ သော့ဖန်တီး သို့မဟုတ် ရုပ်သိမ်းနိုင်သည်။

သော့ကို လျှို့ဝှက်ထားပါ။ အလုပ်နေရာရှိ အရာအားလုံးကို ဖတ်ခွင့်ပေးသည်။ သော့အပြည့်ကို ဖန်တီးပြီးချင်း တစ်ကြိမ်အတိအကျသာ ပြသည် — စကားဝှက်စီမံကိရိယာ သို့မဟုတ် လျှို့ဝှက်ချက်သိမ်းဆည်းရာတွင် သိမ်းပါ။ ပျောက်ပါက ရုပ်သိမ်းပြီး အသစ်ဖန်တီးပါ။

သော့ကို Bearer တိုကင်အဖြစ် အောက်ပါထဲ ပို့ပါ: Authorization ၊ တောင်းဆိုမှုတိုင်း၏ header ဖြစ်သည်:

# List projects in your workspace curl -H "Authorization: Bearer mp_live_..." \ https://www.mouseplayer.com/api/v1/projects

မရှိ၊ ပုံစံမမှန် သို့မဟုတ် ရုပ်သိမ်းသော့များ ရရှိသည့်တုံ့ပြန်ချက်မှာ 401 ဖြစ်သည်:

{ "error": "Invalid or missing API key. Use: Authorization: Bearer <key>" }

အစီအစဉ်လိုအပ်ချက်

REST API ပါဝင်သောအစီအစဉ်များမှာ စီးပွားရေး နှင့် အကြီးစားလုပ်ငန်း ဖြစ်သည်။ အစီအစဉ်ကို သတ်မှတ်ရာမှာ အလုပ်နေရာ၏ ပိုင်ရှင် ထံမှ ဖြစ်သဖြင့် ဖိတ်ကြားအဖွဲ့ဝင်များက ဆက်ခံသည်။ စစ်ဆေးမှုလုပ်သည်မှာ တောင်းဆိုမှုတိုင်းတွင်ဖြစ်ပြီး သော့ဖန်တီးချိန်တင် မဟုတ်ပါ — အလုပ်နေရာအဆင့်လျှော့ပါက ရှိပြီးသားသော့များ အလုပ်ရပ်ပြီး ပြန်ပေးသည်မှာ 403ဖြစ်သည်။

သော့နယ်ပယ်များ

သော့တိုင်းက ကိုယ်ပိုင်ရှေ့ဆက်တွင် နယ်ပယ်ပါသဖြင့် ကြည့်ရုံဖြင့် ဘာလုပ်နိုင်သည်ကို သိနိုင်သည် — အောက်ပါတွင်ဖြစ်စေ .env၊ တောင်းဆိုမှုတစ်ခုတွင်ဖြစ်စေ၊ terminal တစ်ခုတွင်ဖြစ်စေ။

ရှေ့ဆက်	အဓိပ္ပါယ်
`mp_ro_`	ဖတ်ရန်သာ။ ပရောဂျက်၊ ဆက်ရှင်၊ ဖြစ်ရပ်နှင့် အုပ်စုခွဲများ ဖတ်သည်။ ဘာမျှမပြောင်းနိုင်ပါ။
`mp_rw_`	ဖတ်နှင့်ရေး။ အထက်ပါအားလုံးအပြင် identify အဆုံးမှတ်မှ ဖောက်သည် ID တွဲခြင်း။

သော့ဖန်တီးချိန် နယ်ပယ်ရွေးပါ၊ မူလမှာ ဖတ်ရန်သာ။ ရေးအဆုံးမှတ်တွင် ဖတ်ရန်သာသော့သုံးပါက ပြန်သည်မှာ 403 ဖြစ်ပြီး သော့အမျိုးအစားနှင့် အဆုံးမှတ်လိုအပ်ချက်ကို ဖော်ပြသောစာ ပါသည်။ နယ်ပယ်ကို နောက်မှပြောင်း၍မရပါ — သော့အသစ်ဖန်တီးပြီး အဟောင်းရုပ်သိမ်းပါ။

3. တောင်းဆိုနှုန်းကန့်သတ်ချက်များ

API သော့တစ်ခုစီ၏ ကန့်သတ်ချက်မှာ တစ်မိနစ်လျှင် တောင်းဆိုမှု 60 ခုဖြစ်ပြီး ရွေ့လျားအချိန်ကာလဖြင့် ခြေရာခံသည်။ ကျော်လွန်ပါက တောင်းဆိုမှုများ ရရှိသည့်တုံ့ပြန်ချက်မှာ 429 ဖြစ်ပြီး ကာလလွတ်သည်အထိ ဖြစ်သည်:

{ "error": "Rate limit exceeded. Max 60 requests per minute." }

ပိုမြင့်သောကန့်သတ်ချက်လိုသော အရာတည်ဆောက်နေသလား။ ဆက်သွယ်ပါ: အကူအညီ ၊ အသုံးချမှုကို ပြောပြပါ။

4. အဆုံးမှတ်များ

GET/api/v1/projects

အလုပ်နေရာရှိ ပရောဂျက်တိုင်း (ခြေရာခံဝဘ်ဆိုက်) ကို စာရင်းပေးသည်။

{ "data": [ { "channelid": "955a45df5ee842cb", "domain": "yourdomain.com", "status": "active", "total_traffic_bytes": 27304765, "created_at": "2026-07-19 22:06:39", "last_used": "2026-08-05 01:12:55" } ] }

GET/api/v1/projects/{channelid}/sessions

ပရောဂျက်အတွက် မှတ်တမ်းတင်ဧည့်သည်ဆက်ရှင်များကို အသစ်ဆုံးအရင် စာရင်းပေးသည်။ စာမျက်နှာခွဲထားသည်။

Query ပါရာမီတာ	ဖော်ပြချက်
`page`	စာမျက်နှာနံပါတ်၊ မူလမှာ `1`။
`per_page`	စာမျက်နှာတစ်ခုလျှင် ရလဒ်၊ မူလမှာ `25`၊ အများဆုံး `100`။
`since`	ဤရက်၌ သို့မဟုတ် နောက်မှစသောဆက်ရှင်များသာ (`YYYY-MM-DD`)။
`until`	ဤရက်၌ သို့မဟုတ် မတိုင်မီစသောဆက်ရှင်များသာ။

{ "data": [ { "session_id": "s_kfmist058_1785795295504", "visitor_id": "v_sv90jdpzo_1785795296042", "custom_user_id": null, "country": "DE", "device_type": "desktop", "is_bot": 0, "start_time": "2026-08-04 00:14:56", "end_time": "2026-08-04 00:16:41", "duration_seconds": 105 } ], "pagination": { "page": 1, "per_page": 25, "total": 142, "total_pages": 6 } }

GET/api/v1/sessions/{session_id}

ဆက်ရှင်တစ်ခု၏ မီတာဒေတာနှင့် စာမျက်နှာကြည့်မှုများ။ ပြန်ဖွင့်ဒေတာအထုပ်အပြည့်ကို ရည်ရွယ်ချက်ရှိရှိ မထည့်ပါ — ထိုအတွက် ဒက်ရှ်ဘုတ်ဖွင့်ကြည့်စက် သုံးပါ။

{ "data": { "session_id": "s_kfmist058_1785795295504", "channelid": "955a45df5ee842cb", "visitor_id": "v_sv90jdpzo_1785795296042", "country": "DE", "asn_org": "Deutsche Telekom AG", "referrer": "https://duckduckgo.com/", "device_type": "desktop", "start_time": "2026-08-04 00:14:56", "end_time": "2026-08-04 00:16:41", "duration_seconds": 105, "pageviews": [ { "pageview_id": 1199, "url": "https://yourdomain.com/pricing", "page_title": "Pricing", "start_time": "2026-08-04 00:14:56", "end_time": "2026-08-04 00:16:41" } ] } }

GET/api/v1/sessions/{session_id}/events

ဆက်ရှင်အတွင်း အစပျိုးစိတ်ကြိုက်ဖြစ်ရပ်များ (အောက်ပါဖြင့်ပို့သော တူညီဖြစ်ရပ်များ mp('event', ...)) နှင့် ၎င်းတို့ပါရာမီတာများ ပါဝင်သည်။

{ "data": [ { "event_id": 61, "pageview_id": 1199, "event_name": "add_to_cart", "created_at": "2026-08-04 00:14:59", "params": { "item_id": "SKU_98765", "price": 299.99 } } ] }

GET/api/v1/projects/{channelid}/segments

ပရောဂျက်အတွက် သတ်မှတ်ဧည့်သည်အုပ်စုခွဲများကို စာရင်းပေးသည် (ပရောဂျက်သီးသန့်နှင့် အလုပ်နေရာတစ်ခုလုံးအုပ်စုခွဲ နှစ်မျိုးလုံး)။

{ "data": [ { "segment_id": 4, "name": "High Intent Visitors", "description": "Pageviews > 5", "badge_color": "cyan", "is_global": 0, "created_at": "2026-08-03 00:00:43" } ] }

5. နောက်ခံစနစ်မှ ဖောက်သည် ID တွဲခြင်း

ဘရောက်ဇာက ထိုင်နေသူ မည်သူလဲကို မသိတတ်ပါ။ B2B ထုတ်ကုန်တွင် ဝင်ရောက်ပြီးနောက် နောက်ခံစနစ်၌ အထောက်အထားသတ်မှတ်သည် — ဆိုင်တွင် အော်ဒါအတည်ပြုချိန်၌ သတ်မှတ်သည်။ ဤအဆုံးမှတ်သည် ထိုအချိန်အတိအကျအတွက် ဖြစ်သည်။

POST /api/v1/sessions/{session_id}/identify
Authorization: Bearer mp_live_xxxxxxxxxxxx
Content-Type: application/json

{"user_id": "customer-4711"}

// 200 OK
{"data": {"session_id": "s_a1b2c3", "user_id": "customer-4711",
          "changed": true, "previous": null, "webhook_queued": true}}

ထို့နောက် ID သည် ဆက်ရှင်စာရင်းတွင် ပေါ်ပြီး ရှာနိုင်ကာ အောက်ပါ session_identified webhook အစပျိုးသည် — ဤနည်းဖြင့် CRM သို့ ရောက်သည်။

ID တူဖြင့် နှစ်ကြိမ်ခေါ်ခြင်း လုံခြုံသည်။ တုံ့ပြန်ချက်တွင် ပါသည်မှာ "changed": false ဖြစ်ပြီး webhook မပို့ပါ။ ထပ်လုပ်သောအော်ဒါက ဒုတိယစိတ်ဝင်စားဖောက်သည် မဖန်တီးပါ။

အခြေအနေ	ဖြစ်မည့်အချိန်
`400`	လိုအပ်သောအကွက်မရှိ၊ `user_id` အက္ခရာ 128 လုံးထက်ကျော် သို့မဟုတ် ထိန်းချုပ်အက္ခရာ ပါသည်။ ဖြတ်မည့်အစား ငြင်းပယ်သည် — တိတ်တဆိတ်အတိုချုံ့ ID သည် CRM ထဲ မည်သည့်အရာနှင့်မျှ မကိုက်ညီသော်လည်း အောင်မြင်သလို မြင်ရမည်။
`404`	ဆက်ရှင် မရှိပါ သို့မဟုတ် အလုပ်နေရာနှင့် မသက်ဆိုင်ပါ။ နှစ်ခုလုံးအတွက် ရည်ရွယ်ချက်ရှိရှိ အဖြေတူပေးသည်။
`403`	အလုပ်နေရာအစီအစဉ်တွင် API မပါဝင်ပါ။

6. Webhook များ: လက်မှတ်အတည်ပြုခြင်း

Webhook များကို ပရောဂျက်တစ်ခုစီအတွက် အောက်ပါအောက်တွင် သတ်မှတ်သည်: ပေါင်းစည်းချိတ်ဆက်မှုများ၊ လက်မှတ်ထိုးလျှို့ဝှက်ချက်ကိုလည်း ထိုနေရာတွင် တွေ့ရသည်။ ပို့ဆောင်မှုတိုင်းတွင် ဤ header များ ပါသည်:

Header	အဓိပ္ပါယ်
`X-MousePlayer-Event`	ဖြစ်ရပ်အမည်၊ ဥပမာ `session_identified`
`X-MousePlayer-Timestamp`	Unix စက္ကန့် — လက်မှတ်ထိုးစာသား၏ အစိတ်အပိုင်း
`X-MousePlayer-Attempt`	ပထမကြိုးစားမှုတွင် 1၊ ထပ်ကြိုးစားမှုတွင် ပိုမြင့်သည်
`X-MousePlayer-Signature`	`sha256=<hex>`

လက်မှတ်သည် HMAC-SHA256 ဖြစ်ပြီး အောက်ပါစာသားပေါ် တွက်သည်: timestamp + "." + raw body၊ ပရောဂျက်၏ လက်မှတ်ထိုးလျှို့ဝှက်ချက်ကို သော့အဖြစ် သုံးသည်။

// PHP
$erwartet = 'sha256=' . hash_hmac('sha256', $timestamp . '.' . $rawBody, $secret);
if (!hash_equals($erwartet, $signature)) { http_response_code(401); exit; }

// Node
const expected = 'sha256=' + crypto.createHmac('sha256', secret)
                                     .update(timestamp + '.' + rawBody).digest('hex');

လက်မှတ်တွက်ရမည့်အရာမှာ မူရင်းအကြမ်း အကြောင်းအရာဖြစ်ပြီး JSON မဖတ်မီ တွက်ပါ။ ပြန်စီရယ်ပြုပါက သော့အစီအစဉ်နှင့် နေရာလွတ်များ ပြောင်း၍ လက်မှတ် လုံးဝမကိုက်တော့ပါ။ အချိန်တံဆိပ် မိနစ်အနည်းငယ်ထက်ဟောင်းသည့်အရာကိုလည်း ငြင်းပယ်ပါ — ထိုအတွက် အချိန်တံဆိပ် ပါခြင်းဖြစ်သည်။

ပို့ဆောင်မှုနှင့် ထပ်ကြိုးစားမှု

မအောင်မြင်သောပို့ဆောင်မှုကို ထပ်ကြိုးစားမည့်ကြားကာလများမှာ 1 မိနစ်၊ 5 မိနစ်၊ 15 မိနစ်၊ 1 နာရီနှင့် 6 နာရီဖြစ်ပြီး ထို့နောက် လက်လျှော့သည်။ 4xx တုံ့ပြန်ချက်များအနက် အောက်ပါမှလွဲသော အခြားတုံ့ပြန်ချက်များကို 408 နှင့် 429 ခြွင်းချက်ထား၍ ကျန်သည်များကို ထပ်မကြိုးစားပါ — ၎င်းတို့သည် "ဤပုံစံဖြင့်မရ" ဟု ဆိုပြီး "ယခုမရသေး" ဟု မဆိုပါ။ အမြန်တုံ့ပြန်ပါ: 2xx ၊ အလုပ်ကို နောက်မှလုပ်ပါ။ ပို့ဆောင်မှုသည် 10 စက္ကန့်အကြာ အချိန်ကုန်သည်။

ရရှိနိုင်သောဖြစ်ရပ်များ

ဖြစ်ရပ်	အစပျိုးချိန်
`session_identified`	ဆက်ရှင်က ပထမဆုံးဖောက်သည် ID ရသည့်အခါ — ဘရောက်ဇာမှဖြစ်စေ API မှဖြစ်စေ
`session_ended`	ဆက်ရှင်ပိတ်ချိန် တစ်ကြိမ်
`goal_reached`	စိတ်ကြိုက်ဖြစ်ရပ်က ပန်းတိုင်တစ်ခု ပြည့်မီလျှင် ဆက်ရှင်တစ်ခုလျှင် တစ်ကြိမ်။ “event” အမျိုးအစားပန်းတိုင်များသာ — URL၊ ကြာချိန်၊ စာမျက်နှာကြည့်မှုနှင့် ဖန်နယ်ပန်းတိုင်များကို မစစ်ဆေးပါ။ ပါဝင်သည်မှာ `goal_id`၊ `goal_name`၊ `goal_value` နှင့် `currency`ဖြစ်သည်။
`high_value_session`	သတ်မှတ်ရက်တစ်ရက်တွင် ဧည့်သည်က ပရောဂျက်တန်ဖိုးသတ်မှတ်ချက်ကို ပထမဆုံးကျော်သောအခါ။ သတ်မှတ်ချက်သည် ကိုယ်ပိုင်ရမှတ်ဖြန့်ဝေမှုမှ ဆင်းသက်သည် (လွန်ခဲ့သော 90 ရက်၏ 90th percentile)၊ ပုံသေကိန်းမဟုတ်ဘဲ အနည်းဆုံးဧည့်သည် 20 ကို ရမှတ်မပေးမချင်း မရှိပါ။ ပါဝင်သည်မှာ `visitor_id`၊ `value_score`၊ `threshold` နှင့် ထိုနေ့၏ ကြည့်သင့်ဆုံးဆက်ရှင်ဖြစ်သည်။
`funnel_dropoff`	ဖန်နယ်တစ်ခုသို့ ဝင်ပြီး မပြီးဆုံးသော ဆက်ရှင်အဆုံး၌ ဖြစ်သည်။ ရပ်ခဲ့သည့်အဆင့်ကို အမည်ဖော်ပြသည် (`dropped_at`)။ လမ်းခုလတ်ထွက်ခွာမှုသည် ဖြစ်ရပ်မရှိခြင်းဖြစ်သဖြင့် ဆက်ရှင်ကုန်မှသာ သိနိုင်သည်။ ဖန်နယ်သို့ လုံးဝမဝင်ခဲ့သောဆက်ရှင်သည် လမ်းခုလတ်ထွက်ခွာမှု မဟုတ်ဘဲ အစမပျိုးပါ။
`high_friction_session`	အတားအဆီးရမှတ်က သတ်မှတ်ချက် (မူလ 60 / 100) ကို ပထမဆုံးရောက်ချိန် ဆက်ရှင်တစ်ခုလျှင် တစ်ကြိမ်။ ပါဝင်သည်မှာ `friction_score`၊ နောက်ကွယ်အချက်ပြများ (`reasons`) နှင့် သတ်မှတ်မျဉ်းကျော်စေသော အချက်ပြ (`trigger`) ဖြစ်သည်။
`element_broken`	ခြေရာခံအစိတ်အပိုင်းသည် စစ်ဆေးစာမျက်နှာကြည့်မှုအားလုံးတွင် ရက်အနည်းငယ်ကြာ ဘာမျှမတွေ့သောအခါ တစ်ကြိမ် — ပုံမှန်အားဖြင့် ဝဘ်ဆိုက်အသစ်ပြန်ဖွင့်ပြီးနောက်။ အမှတ်အသား ပြန်ကိုက်ညီပြီး နောက်တစ်ကြိမ်ပျက်မှသာ ထပ်အစပျိုးသည်။ ဤဖြစ်ရပ်သည် မည်သည့်ဆက်ရှင်နှင့်မျှ မသက်ဆိုင်ပါ: `session_id` နှင့် `session_url` တို့၏တန်ဖိုးမှာ `null`ဖြစ်သည်၊ `link_url` က အစားထိုး၍ အမှတ်အသားကို ဖွင့်ပြီး `subject_id` က အမှတ်အသားကို အမည်ပေးသည် — ဗားရှင်းတိုင်းတွင် တူသဖြင့် ထပ်ပျက်သော ရွေးချယ်ကိရိယာအသစ်သည် ဖွင့်ထားဆဲဖြစ်စဉ်ထဲ ပါသွားသည်။ ပါဝင်သည်မှာ `rule_id`၊ `rule_name`၊ `selector`၊ `page`၊ `checked_page_views`၊ `window_days` နှင့် `last_matched`ဖြစ်သည်။ ဧည့်သည်ဒေတာ မပါပါ။
`element_recovered`	အောက်ပါအတွက် ပြန်ကောင်းကြောင်းအချက်ပြ: `element_broken`၊ အမှတ်အသားက အစိတ်အပိုင်းတစ်ခုကို အမှန်တကယ် ပြန်တွေ့မှဖြစ်သည် — စာမျက်နှာကြည့်မှု နည်းလွန်းရုံ မလုံလောက်ပါ။ အောက်ပါဖြစ်ရပ် `element_broken` ကို webhook ဖြင့်ပို့ခဲ့မှသာ ပို့ပြီး ကိုယ်ပိုင်ဖွင့်ပိတ်ခလုတ် မရှိပါ။ အောက်ပါကို စာရင်းသွင်းလျှင် `element_broken` ဤဖြစ်ရပ်ပါဝင်သည်။ တူညီသော `subject_id`ဖြစ်သဖြင့် PagerDuty က ဖြစ်စဉ်ဖြေရှင်း၍ Opsgenie က သတိပေးချက်ပိတ်သည်။ အပိုပါဝင်သည်မှာ `matched_page_views` နှင့် `checked_page_views` ဖြစ်သည်။
`anomaly_detected`	မနေ့ကသည် ယခင် 28 ရက်နှင့် သိသာစွာကွာသောအခါ တစ်ရက်လျှင် တစ်ကြိမ်: ဆက်ရှင်အလွန်နည်း သို့မဟုတ် များ၊ ပန်းတိုင်နှုန်းကျ၊ အတားအဆီး သို့မဟုတ် JS အမှားပါဆက်ရှင် ပိုများခြင်း။ တူညီမက်ထရစ်နှင့် ဦးတည်ချက်သည် တစ်ပတ်ကြာ ငြိမ်နေသည် (ပြင်နိုင်သည်)။ ဤဖြစ်ရပ်သည် မည်သည့်ဆက်ရှင်နှင့်မျှ မသက်ဆိုင်ပါ: `session_id` နှင့် `session_url` တို့၏တန်ဖိုးမှာ `null`ဖြစ်သည်၊ `link_url` က ပရောဂျက်အကျဉ်းချုပ်ဖွင့်ပြီး `subject_id` က မက်ထရစ်၊ ဦးတည်ချက်နှင့် ရက်ကို အမည်ပေးသည်။ ပါဝင်သည်မှာ `metric` (`sessions`၊ `goal_rate`၊ `friction_rate`၊ `js_error_rate`၊ `lcp_p75`၊ `inp_p75`၊ `cls_p75`)၊ `direction`၊ `day`၊ `value`၊ `expected`၊ `sessions`၊ `robust_z`၊ `z_score` နှင့် ဖတ်နိုင်သော `summary` နှင့် `hint`ဖြစ်သည်။ ဧည့်သည်ဒေတာ မပါပါ။ Web Vitals အတွက် `measurements` သည် အစားထိုးသည်မှာ `sessions`ဖြစ်ပြီး၊ `page` (ဝဘ်ဆိုက်တစ်ခုလုံးအတွက် ဗလာ) နှင့် `device` (`desktop` သို့မဟုတ် `mobil`) တို့က ဖြစ်ပျက်ရာနေရာကို ပြောသည်။ `link_url` က ထို့နောက် Web Vitals တက်ဘ်ကို ဖွင့်သည်။
`rage_click`	စိတ်တို၍ အကြိမ်ကြိမ်ကလစ်နှိပ်မှု တွေ့သောအခါ
`error_detected`	ရှေ့ပိုင်းခြွင်းချက် ဖြစ်သောအခါ
`ce`	ကိုယ်ပိုင်စိတ်ကြိုက်ဖြစ်ရပ်များအတွက် စုပေါင်းစာရင်းသွင်းမှု။ ၎င်းတွင် မပါဝင်ပါ ၊ အထက်ပါဖြစ်ရပ်များဖြစ်သည် — ၎င်းတို့တွင် ကိုယ်ပိုင်ခလုတ်များ ရှိသည်။

7. အမှားများ & အခြေအနေကုဒ်များ

အခြေအနေ	အဓိပ္ပါယ်
`200`	အောင်မြင်မှု။
`401`	API သော့မရှိ၊ ပုံစံမမှန် သို့မဟုတ် ရုပ်သိမ်းထားသည်။
`404`	တောင်းသောပရောဂျက် သို့မဟုတ် ဆက်ရှင် မရှိ သို့မဟုတ် အလုပ်နေရာနှင့် မသက်ဆိုင်ပါ။
`429`	နှုန်းကန့်သတ်ချက် ကျော်လွန်သည် — ဤသော့ဖြင့် တစ်မိနစ် တောင်းဆိုမှု 60 ထက်ပို ပို့နေသည်။
`403`	အလုပ်နေရာအစီအစဉ်တွင် REST API မပါဝင်ပါ။ စာတွင် လိုအပ်အစီအစဉ်နှင့် လက်ရှိအစီအစဉ် နှစ်ခုလုံး ဖော်ပြသည်။

8. လုံခြုံရေးမှတ်ချက်များ

ဖတ်ရန်သာသော့များ (mp_ro_) သည် ဘာမျှမပြောင်းနိုင်ပါ။ ရေးသော့များ (mp_rw_) သည် ဖောက်သည် ID တွဲခြင်းသာ လုပ်နိုင်သည်။ မည်သည့်သော့မျှ ဒေတာဖျက် သို့မဟုတ် ဒေတာအကြမ်းပြန်ဖွင့်မှု ထုတ်ပို့၍မရပါ။
တောင်းဆိုမှုတိုင်းကို သော့၏ကိုယ်ပိုင်အလုပ်နေရာသို့ အလိုအလျောက်ကန့်သတ်သည် — အခြားအလုပ်နေရာ ID ပို့၍ သူတစ်ပါးဒေတာကြည့်ရန် နည်းမရှိပါ။
သော့ကို အချိန်မရွေး အောက်ပါမှ ရုပ်သိမ်းနိုင်သည်: /api-keys။ ရုပ်သိမ်းမှု ချက်ချင်းသက်ရောက်သည်။
API သော့ကို စကားဝှက်ကဲ့သို့ ကိုင်တွယ်ပါ။ အများသုံး repository သို့ မတော်တဆ commit လုပ်မိပါက ချက်ချင်းရုပ်သိမ်းပြီး အသစ်ဖန်တီးပါ။

အရွယ်ကန့်သတ်ဖြစ်ရပ်စာမျက်နှာများ (API v1၊ 14 အောက်တိုဘာ 2026)

GET /api/v1/sessions/{session_id}/events သည် မူလအားဖြင့် ဖြစ်ရပ် 100 အထိ ပြန်ပေးသည်။ per_page ကို 1 မှ 100 အတွင်း ကိန်းပြည့်သတ်မှတ်ပါ။ pagination.next_cursor ကို လိုက်ရန် နောက်တောင်းဆိုမှုတွင် cursor ကို မပြောင်းဘဲပို့ပါ။ ဆက်ရှင်နှင့် အလုပ်နေရာတူ ထားပါ။ ဖြစ်ရပ်များကို created_at နှင့် event_id အလိုက်စီသည်။ Cursor များကို လက်မှတ်ထိုးပြီး ထိုဆက်ရှင်နှင့် အလုပ်နေရာနှင့် ချိတ်ထားသည်။ စုစုပေါင်းအရေအတွက် သို့မဟုတ် ဂဏန်းစာမျက်နှာ မပြန်ပါ။

ရှိပြီးသား data အာရေးနှင့် params map ကို ဆက်ရရှိနိုင်သည်။ pagination.returned သည် အမှန်ပြန်ပေးအရေအတွက်ဖြစ်ပြီး pagination.has_more က နောက်စာမျက်နှာရှိကြောင်း ပြသည်။ ပြည့်စုံပါက next_cursor သည် null ဖြစ်သည်။ တုံ့ပြန်ချက်ကို 524288 ဘိုက်အထိ ကန့်သတ်သဖြင့် စာမျက်နှာတွင် per_page ထက် ဖြစ်ရပ်ပိုနည်းနိုင်သည်။ ဖြစ်ရပ်တစ်ခုလျှင် အများဆုံး ပါရာမီတာအတန်း 128 ပြန်ပေးပြီး ပိုရှိပါက params_truncated သည် true ဖြစ်သည်။ စာသားပါရာမီတာတစ်ခုချင်းအတွက် ဒေတာဘေ့စ်ကန့်သတ်ချက် အက္ခရာ 255 လုံးကို ထိန်းထားသည်။ ဖြတ်ထားသောပါရာမီတာများကို ဤအဆုံးမှတ်မှ မရနိုင်ပါ။ per_page လျှော့ခြင်းက ပါရာမီတာကန့်သတ်ချက် မတိုးပါ။

မမှန်သောစာမျက်နှာအရွယ်၊ ပြောင်းထားသော cursor နှင့် အခြားဆက်ရှင်/အလုပ်နေရာအတွက် cursor များက 400 ပြန်သည်။ အလွန်ကြီးသောဖြစ်ရပ်တစ်ခုဒေတာက 413 ပြန်သည်။ ရှိပြီးသားဝင်ရောက်စစ်ဆေးမှုများက သင့်လျော်သလို 401, 403, 404 သို့မဟုတ် 409 ဆက်ပြန်သည်။

ကန့်သတ်ချက်သည် API သော့တစ်ခုလျှင် တစ်မိနစ် အတည်ပြုတောင်းဆိုမှု 60 အတိုင်းဖြစ်သည်။ ပြည့်သွားပါက 429 နှင့် Retry-After: 60 ပြန်သည်။ Redis သို့မဟုတ် နှုန်းကန့်သတ်ကိရိယာ မရနိုင်ပါက 503 နှင့် Retry-After: 5 ပြန်သည်။ ကန့်သတ်ချက်မရှိဘဲ လုံးဝမလက်ခံပါ။ Retry-After ကို လိုက်နာပြီး ကျပန်းစောင့်ချိန်တိုးပါ။ နီးနီးကပ်ကပ် အဆက်မပြတ်ထပ်မကြိုးစားပါနှင့်။ ဖြစ်ရပ်ဒေတာဘေ့စ်မအောင်မြင်မှုများလည်း 503 ပြန်သည်။ Cursor များက ပုံရိပ်ကို မတည်ငြိမ်ထားပါ: အချိန်တံဆိပ်ဟောင်းဖြင့် တစ်ပြိုင်နက်ထည့်မှုများအတွက် အသစ်ပြန်စစ်ရန် လိုနိုင်သည်။

GET /api/v1/sessions/s_example/events?per_page=25
GET /api/v1/sessions/s_example/events?per_page=25&cursor=SIGNED_CURSOR

/api/v1/native သည် နေတစ်ဗ် SDK အစမ်းကြည့်မှုအတွက် Dev သီးသန့်နောက်ခံထိန်းချုပ်လမ်းကြောင်းဖြစ်သည်။ ထုတ်လုပ်အသုံးပြုမှုတွင် ပိတ်ထားဆဲဖြစ်သည်။ နောက်ခံ Bearer သော့များတွင် list/replay အတွက် ဖတ်နယ်ပယ်နှင့် register/grant/delete/disable အတွက် ရေးနယ်ပယ် လိုသည်။ နေတစ်ဗ်အစမ်းကြည့်ရရှိနိုင်မှု အပိုစစ်ဆေးချက်များ သက်ရောက်သည်။ အမြဲတမ်းအလုပ်နေရာ API သော့များကို မိုဘိုင်းအက်ပ်ထဲ လုံးဝမထည့်ပါနှင့်။

မည်သို့ကူညီပေးရမလဲ။