ಸಾರ್ವಜನಿಕ 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 :
ಇಲ್ಲದ, ತಪ್ಪು ರೂಪದ ಅಥವಾ ರದ್ದುಪಡಿಸಿದ ಕೀಗಳಿಗೆ ಈ ಉತ್ತರ ಸಿಗುತ್ತದೆ: 401 :
ಯೋಜನೆಯ ಅವಶ್ಯಕತೆ
REST API ಈ ಯೋಜನೆಗಳ ಭಾಗ: Business ಮತ್ತು Enterprise . ಯೋಜನೆಯನ್ನು ಕಾರ್ಯಕ್ಷೇತ್ರದ ಈ ವ್ಯಕ್ತಿಯಿಂದ ಪಡೆಯಲಾಗುತ್ತದೆ: ಮಾಲೀಕರು ; ಆದ್ದರಿಂದ ಆಹ್ವಾನಿತ ತಂಡದ ಸದಸ್ಯರಿಗೂ ಅನ್ವಯಿಸುತ್ತದೆ. ಪರಿಶೀಲನೆ ನಡೆಯುವುದು ಪ್ರತಿ ವಿನಂತಿಯಲ್ಲಿ, ಕೀ ರಚಿಸುವಾಗ ಮಾತ್ರವಲ್ಲ — ಕಾರ್ಯಕ್ಷೇತ್ರ ಕಡಿಮೆ ಯೋಜನೆಗೆ ಬದಲಾದರೆ ಈಗಿನ ಕೀಗಳು ಕೆಲಸ ನಿಲ್ಲಿಸಿ ಈ ಉತ್ತರ ನೀಡುತ್ತವೆ: 403.
ಕೀ ವ್ಯಾಪ್ತಿಗಳು
ಪ್ರತಿ ಕೀ ತನ್ನ ಪೂರ್ವಪ್ರತ್ಯಯದಲ್ಲಿ ವ್ಯಾಪ್ತಿ ಹೊಂದಿರುತ್ತದೆ; ಹೀಗಾಗಿ ನೋಡಿ ಮಾತ್ರ ಅದು ಮಾಡುವುದನ್ನು ತಿಳಿಯಬಹುದು — ಈ ಸ್ಥಳದಲ್ಲಿ .env, ಟಿಕೆಟ್ ಅಥವಾ ಟರ್ಮಿನಲ್‌ನಲ್ಲಿ.
| ಪೂರ್ವಪ್ರತ್ಯಯ | ಅರ್ಥ |
|---|---|
mp_ro_ | ಓದಲು ಮಾತ್ರ. ಪ್ರಾಜೆಕ್ಟ್‌ಗಳು, ಸೆಷನ್‌ಗಳು, ಘಟನೆಗಳು ಮತ್ತು ವಿಭಾಗಗಳನ್ನು ಓದುತ್ತದೆ. ಏನನ್ನೂ ಬದಲಾಯಿಸಲಾಗುವುದಿಲ್ಲ. |
mp_rw_ | ಓದಲು ಮತ್ತು ಬರೆಯಲು. ಮೇಲಿನ ಎಲ್ಲದರ ಜೊತೆಗೆ identify ಎಂಡ್‌ಪಾಯಿಂಟ್ ಮೂಲಕ ಗ್ರಾಹಕರ ID ಜೋಡಿಸುವಿಕೆ. |
403 ; ಕೀ ಪ್ರಕಾರ ಮತ್ತು ಎಂಡ್‌ಪಾಯಿಂಟ್ ಅಗತ್ಯ ವಿವರಿಸುವ ಸಂದೇಶದೊಂದಿಗೆ. ನಂತರ ವ್ಯಾಪ್ತಿ ಬದಲಿಸಲಾಗುವುದಿಲ್ಲ — ಹೊಸ ಕೀ ರಚಿಸಿ ಹಳೆಯದು ರದ್ದುಪಡಿಸಿ.3. ವಿನಂತಿ ದರ ಮಿತಿಗಳು
ಪ್ರತಿ API ಕೀಯ ಮಿತಿ ನಿಮಿಷಕ್ಕೆ 60 ವಿನಂತಿಗಳು; ಚಲಿಸುವ ಅವಧಿಯಲ್ಲಿ ಎಣಿಕೆ. ಮೀರಿದರೆ ಅವಧಿ ಖಾಲಿಯಾಗುವವರೆಗೆ ವಿನಂತಿಗಳಿಗೆ ಈ ಉತ್ತರ: 429 :
ಹೆಚ್ಚಿನ ಮಿತಿ ಬೇಕಾದ ವ್ಯವಸ್ಥೆ ನಿರ್ಮಿಸುತ್ತಿದ್ದೀರಾ? ಈ ಮೂಲಕ ಸಂಪರ್ಕಿಸಿ: ಬೆಂಬಲ ; ನಿಮ್ಮ ಬಳಕೆಯ ಸಂದರ್ಭ ತಿಳಿಸಿ.
4. ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳು
GET/api/v1/projects
ಕಾರ್ಯಕ್ಷೇತ್ರದ ಪ್ರತಿ ಪ್ರಾಜೆಕ್ಟ್ (ಟ್ರ್ಯಾಕ್ ಮಾಡಿದ ಪ್ರಾಪರ್ಟಿ) ಪಟ್ಟಿ ಮಾಡುತ್ತದೆ.
GET/api/v1/projects/{channelid}/sessions
ಪ್ರಾಜೆಕ್ಟ್‌ಗೆ ರೆಕಾರ್ಡ್ ಮಾಡಿದ ಭೇಟಿದಾರರ ಸೆಷನ್‌ಗಳು, ಹೊಸವು ಮೊದಲು. ಪುಟಗಳಾಗಿ ವಿಭಜಿಸಲಾಗಿದೆ.
| ಕ್ವೆರಿ ಪ್ಯಾರಾಮೀಟರ್ | ವಿವರಣೆ |
|---|---|
page | ಪುಟ ಸಂಖ್ಯೆ, ಪೂರ್ವನಿಯೋಜಿತ 1. |
per_page | ಪ್ರತಿ ಪುಟದ ಫಲಿತಾಂಶಗಳು, ಪೂರ್ವನಿಯೋಜಿತ 25, ಗರಿಷ್ಠ 100. |
since | ಈ ದಿನಾಂಕದಂದು/ನಂತರ ಆರಂಭವಾದ ಸೆಷನ್‌ಗಳು ಮಾತ್ರ (YYYY-MM-DD). |
until | ಈ ದಿನಾಂಕದಂದು/ಮೊದಲು ಆರಂಭವಾದ ಸೆಷನ್‌ಗಳು ಮಾತ್ರ. |
GET/api/v1/sessions/{session_id}
ಒಂದು ಸೆಷನ್‌ನ ಮೆಟಾಡೇಟಾ ಮತ್ತು ಪುಟ ವೀಕ್ಷಣೆಗಳು. ಪೂರ್ಣ ಮರುಪ್ಲೇ ಪೇಲೋಡ್ ಉದ್ದೇಶಪೂರ್ವಕವಾಗಿ ಹೊರಗಿದೆ — ಅದಕ್ಕಾಗಿ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್ ಪ್ಲೇಯರ್ ಬಳಸಿ.
GET/api/v1/sessions/{session_id}/events
ಸೆಷನ್‌ನಲ್ಲಿ ಪ್ರಚೋದಿತ ಕಸ್ಟಮ್ ಘಟನೆಗಳು (ನೀವು ಈ ಮೂಲಕ ಕಳುಹಿಸುವ ಅದೇ ಘಟನೆಗಳು: mp('event', ...)), ಅವುಗಳ ಪ್ಯಾರಾಮೀಟರ್‌ಗಳೊಂದಿಗೆ.
GET/api/v1/projects/{channelid}/segments
ಪ್ರಾಜೆಕ್ಟ್‌ಗೆ ವ್ಯಾಖ್ಯಾನಿಸಿದ ಭೇಟಿದಾರರ ವಿಭಾಗಗಳು (ಪ್ರಾಜೆಕ್ಟ್‌ಗೆ ನಿರ್ದಿಷ್ಟ ಮತ್ತು ಕಾರ್ಯಕ್ಷೇತ್ರದಾದ್ಯಂತ ಇರುವ ಎರಡೂ).
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 ಸೆಷನ್ ಪಟ್ಟಿಯಲ್ಲಿ ಕಾಣುತ್ತದೆ, ಹುಡುಕಬಹುದು; ಈ webhook session_identified ಪ್ರಚೋದಿತವಾಗುತ್ತದೆ — ಹೀಗೆ CRM ತಲುಪುತ್ತದೆ.
"changed": false ; ಯಾವುದೇ webhook ಕಳುಹಿಸುವುದಿಲ್ಲ. ಮರುಕಳಿಸಿದ ಆರ್ಡರ್ ಎರಡನೇ ಲೀಡ್ ರಚಿಸುವುದಿಲ್ಲ.| ಸ್ಥಿತಿ | ಸಂದರ್ಭ |
|---|---|
400 | ಫೀಲ್ಡ್ ಇಲ್ಲ, user_id 128 ಅಕ್ಷರಗಳಿಗಿಂತ ಹೆಚ್ಚು ಅಥವಾ ನಿಯಂತ್ರಣ ಅಕ್ಷರಗಳಿವೆ. ಕತ್ತರಿಸದೆ ತಿರಸ್ಕರಿಸುತ್ತೇವೆ — ಮೌನವಾಗಿ ಚಿಕ್ಕದಾದ ID ನಿಮ್ಮ CRM ನಲ್ಲಿ ಯಾವುದಕ್ಕೂ ಹೊಂದದಿದ್ದರೂ ಯಶಸ್ಸಿನಂತೆ ಕಾಣುತ್ತದೆ. |
404 | ಸೆಷನ್ ಇಲ್ಲ ಅಥವಾ ನಿಮ್ಮ ಕಾರ್ಯಕ್ಷೇತ್ರಕ್ಕೆ ಸೇರಿಲ್ಲ. ಎರಡಕ್ಕೂ ಉದ್ದೇಶಪೂರ್ವಕವಾಗಿ ಒಂದೇ ಉತ್ತರ. |
403 | ಕಾರ್ಯಕ್ಷೇತ್ರದ ಯೋಜನೆಯಲ್ಲಿ API ಇಲ್ಲ. |
6. webhook ಗಳು: ಸಹಿ ಪರಿಶೀಲನೆ
ಪ್ರಾಜೆಕ್ಟ್‌ವಾರು webhook ಗಳನ್ನು ಈ ವಿಭಾಗದಲ್ಲಿ ಹೊಂದಿಸಲಾಗುತ್ತದೆ: ಏಕೀಕರಣಗಳು; ಅಲ್ಲಿ ಸಹಿ ಸೀಕ್ರೆಟ್ ಕೂಡ ಇದೆ. ಪ್ರತಿ ರವಾನೆಯಲ್ಲಿ ಈ ಹೆಡರ್‌ಗಳಿರುತ್ತವೆ:
| ಹೆಡರ್ | ಅರ್ಥ |
|---|---|
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');
ರವಾನೆ ಮತ್ತು ಮರುಪ್ರಯತ್ನಗಳು
ವಿಫಲ ರವಾನೆಯನ್ನು ಈ ಅಂತರಗಳ ನಂತರ ಮರುಪ್ರಯತ್ನಿಸಲಾಗುತ್ತದೆ: 1 min, 5 min, 15 min, 1 h ಮತ್ತು 6 h; ನಂತರ ಕೈಬಿಡಲಾಗುತ್ತದೆ. 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 ದಿನಗಳ 90ನೇ ಪರ್ಸೆಂಟೈಲ್), ಸ್ಥಿರ ಸಂಖ್ಯೆಯಲ್ಲ; ಕನಿಷ್ಠ 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: ಗುರುತು ನಿಜವಾಗಿ ಮತ್ತೆ ಅಂಶ ಕಂಡಾಗ — ಪುಟ ವೀಕ್ಷಣೆಗಳು ಕಡಿಮೆ ಇರುವುದಷ್ಟೇ ಸಾಕಾಗುವುದಿಲ್ಲ. ಈ ಘಟನೆ webhook ಮೂಲಕ ಹೋಗಿದ್ದರೆ ಮಾತ್ರ ಕಳುಹಿಸಲಾಗುತ್ತದೆ: element_broken ; ಇದಕ್ಕೆ ತನ್ನದೇ ಸ್ವಿಚ್ ಇಲ್ಲ: ಇದಕ್ಕೆ ಚಂದಾದಾರರಾದರೆ 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 ಕೀಯನ್ನು ಪಾಸ್‌ವರ್ಡ್‌ನಂತೆ ಕಾಪಾಡಿ. ಆಕಸ್ಮಿಕವಾಗಿ ಸಾರ್ವಜನಿಕ ರೆಪೊಸಿಟರಿಯಲ್ಲಿ ಕಮಿಟ್ ಮಾಡಿದರೆ ತಕ್ಷಣ ರದ್ದುಪಡಿಸಿ ಹೊಸ ಕೀ ರಚಿಸಿ.
ಮಿತಿಯ ಘಟನೆ ಪುಟಗಳು (API v1, 14 ಅಕ್ಟೋಬರ್ 2026)
GET /api/v1/sessions/{session_id}/events ಪೂರ್ವನಿಯೋಜಿತವಾಗಿ ಗರಿಷ್ಠ 100 ಘಟನೆಗಳನ್ನು ನೀಡುತ್ತದೆ. per_page ಅನ್ನು 1 ರಿಂದ 100 ರ ನಡುವಿನ ಪೂರ್ಣಾಂಕಕ್ಕೆ ಹೊಂದಿಸಿ. ಮುಂದಿನ ವಿನಂತಿಯಲ್ಲಿ cursor ಬದಲಿಸದೆ ಕಳುಹಿಸಿ pagination.next_cursor ಅನುಸರಿಸಿ; ಅದೇ ಸೆಷನ್ ಮತ್ತು ಕಾರ್ಯಕ್ಷೇತ್ರ ಉಳಿಸಿ. ಘಟನೆಗಳನ್ನು created_at ಮತ್ತು event_id ಪ್ರಕಾರ ಕ್ರಮಗೊಳಿಸಲಾಗಿದೆ. ಕರ್ಸರ್‌ಗಳು ಸಹಿ ಹೊಂದಿದ್ದು ಆ ಸೆಷನ್ ಮತ್ತು ಕಾರ್ಯಕ್ಷೇತ್ರಕ್ಕೆ ಬದ್ಧವಾಗಿವೆ. ಒಟ್ಟು ಎಣಿಕೆ ಅಥವಾ ಸಂಖ್ಯಾ ಪುಟ ನೀಡುವುದಿಲ್ಲ.
ಈಗಿನ data ಅರೇ ಮತ್ತು params ಮ್ಯಾಪ್ ಲಭ್ಯವಿರುತ್ತವೆ. pagination.returned ನಿಜವಾಗಿ ನೀಡಿದ ಸಂಖ್ಯೆ; pagination.has_more ಮುಂದಿನ ಪುಟ ಸೂಚಿಸುತ್ತದೆ. ಪೂರ್ಣವಾದಾಗ next_cursor null. ಉತ್ತರದ ಮಿತಿ 524288 ಬೈಟ್‌ಗಳು; ಹೀಗಾಗಿ ಪುಟದಲ್ಲಿ per_page ಗಿಂತ ಕಡಿಮೆ ಘಟನೆಗಳು ಇರಬಹುದು. ಪ್ರತಿ ಘಟನೆಗೆ ಗರಿಷ್ಠ 128 ಪ್ಯಾರಾಮೀಟರ್ ಸಾಲುಗಳು; ಇನ್ನಷ್ಟು ಇದ್ದರೆ params_truncated true. ಪ್ರತ್ಯೇಕ ಸ್ಟ್ರಿಂಗ್ ಪ್ಯಾರಾಮೀಟರ್‌ಗಳಿಗೆ ಡೇಟಾಬೇಸ್‌ನ 255 ಅಕ್ಷರಗಳ ಮಿತಿ ಉಳಿಯುತ್ತದೆ. ಕತ್ತರಿಸಿದ ಪ್ಯಾರಾಮೀಟರ್‌ಗಳು ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ನಲ್ಲಿ ಲಭ್ಯವಿಲ್ಲ. per_page ಕಡಿಮೆ ಮಾಡಿದರೆ ಪ್ಯಾರಾಮೀಟರ್ ಮಿತಿ ಏರುವುದಿಲ್ಲ.
ಅಮಾನ್ಯ ಪುಟ ಗಾತ್ರಗಳು, ಬದಲಿಸಿದ ಕರ್ಸರ್‌ಗಳು ಮತ್ತು ಬೇರೆ ಸೆಷನ್/ಕಾರ್ಯಕ್ಷೇತ್ರದ ಕರ್ಸರ್‌ಗಳಿಗೆ 400 ಬರುತ್ತದೆ. ಪ್ರತ್ಯೇಕ ಘಟನೆಯ ಅತಿದೊಡ್ಡ ಡೇಟಾಗೆ 413. ಈಗಿನ ಪ್ರವೇಶ ಪರಿಶೀಲನೆಗಳು ಅಗತ್ಯಕ್ಕೆ ತಕ್ಕಂತೆ 401, 403, 404 ಅಥವಾ 409 ನೀಡುತ್ತವೆ.
ಮಿತಿ ಪ್ರತಿ API ಕೀಗೆ ನಿಮಿಷಕ್ಕೆ 60 ದೃಢೀಕೃತ ವಿನಂತಿಗಳೇ. ಮಿತಿ ಮುಗಿದರೆ 429, ಜೊತೆಗೆ Retry-After: 60. Redis ಅಥವಾ ಮಿತಿ ಪರಿಕರ ಲಭ್ಯವಿಲ್ಲದಿದ್ದರೆ 503, ಜೊತೆಗೆ Retry-After: 5; ಮಿತಿಯಿಲ್ಲದೆ ಎಂದಿಗೂ ಪ್ರವೇಶ ನೀಡುವುದಿಲ್ಲ. Retry-After ಪಾಲಿಸಿ ಯಾದೃಚ್ಛಿಕ ವಿರಾಮ ಸೇರಿಸಿ; ವೇಗದ ಮರುಪ್ರಯತ್ನ ಚಕ್ರ ಬೇಡ. ಘಟನೆ ಡೇಟಾಬೇಸ್ ವಿಫಲತೆಗಳೂ 503 ನೀಡುತ್ತವೆ. ಕರ್ಸರ್‌ಗಳು ಸ್ನ್ಯಾಪ್‌ಶಾಟ್ ಸ್ಥಿರಗೊಳಿಸುವುದಿಲ್ಲ: ಹಳೆಯ ಟೈಮ್‌ಸ್ಟ್ಯಾಂಪ್‌ನ ಸಮಕಾಲೀನ ಸೇರಿಸುವಿಕೆಗಳಿಗೆ ಹೊಸ ಸ್ಕ್ಯಾನ್ ಬೇಕಾಗಬಹುದು.
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 ಗಾಗಿ ಬರೆಯುವ ವ್ಯಾಪ್ತಿ ಅಗತ್ಯ. ಹೆಚ್ಚುವರಿ native-preview ಲಭ್ಯತೆ ಪರಿಶೀಲನೆಗಳು ಅನ್ವಯಿಸುತ್ತವೆ. ಶಾಶ್ವತ ಕಾರ್ಯಕ್ಷೇತ್ರ API ಕೀಗಳನ್ನು ಮೊಬೈಲ್ ಆ್ಯಪ್‌ನಲ್ಲಿ ಎಂದಿಗೂ ಎಂಬೆಡ್ ಮಾಡಬೇಡಿ.