API 文档
Monit 提供完整的 REST API:控制台可见的数据都能通过 API 读写,适合对接 BI、报表与自动化流程。
认证
所有 /api/v1 端点均需 Bearer Token 认证(用户 API Key),请在请求头中携带:
curl https://www.monit.com.cn/api/v1/user \
-H "Authorization: Bearer YOUR_API_KEY"
接口基础地址: https://www.monit.com.cn/api/v1
API Key 在 账号设置 → API 密钥
账户
| 方法 | 端点 | 说明 |
|---|---|---|
| GET | /api/v1/user | 当前账户信息 |
| GET | /api/v1/logs | 操作日志列表 |
| GET | /api/v1/payments | 支付记录列表 |
| GET/POST/PUT/DELETE | /api/v1/dashboard-views[/{view}] | 自定义仪表盘增删改查 |
| GET/POST/DELETE | /api/v1/teams[/{team}][/members[/{memberId}]] | 团队与成员管理 |
| GET | /api/v1/plans | 可用套餐(只读) |
网站与域名
| 方法 | 端点 | 说明 |
|---|---|---|
| GET/POST/PUT/DELETE | /api/v1/websites[/{website}] | 网站增删改查与像素 Key |
| GET | /api/v1/domains · /api/v1/domains/{domainId} | 域名监控与 WHOIS |
数据分析
以下端点会自动校验网站归属权,仅返回你有权限的网站数据。
| 方法 | 端点 | 说明 |
|---|---|---|
| GET | /api/v1/websites/{website}/realtime | 实时在线访客 |
| GET | /api/v1/websites/{website}/visitors | 访客列表(聚合) |
| GET | /api/v1/websites/{website}/events | 访问事件流 |
| GET | /api/v1/websites/{website}/metrics | 核心指标 |
| GET | /api/v1/websites/{website}/top-pages · top-referrers · top-countries · top-browsers · top-devices · top-operating-systems | 热门页面/来源/国家/浏览器/设备/系统 |
| GET | /api/v1/websites/{website}/statistics | 统计聚合 |
| GET | /api/v1/websites/{website}/pageviews-advanced · pageviews-lightweight | 高级/轻量双模式浏览数据 |
| GET | /api/v1/websites/{website}/sessions[/list][/{sessionId}] | 会话列表与详情 |
| GET | /api/v1/websites/{website}/replays[/list][/{replayId}] | 会话回放列表与详情 |
| GET | /api/v1/websites/{website}/visitors/list · visitors/{visitorId} | 访客列表与详情 |
| GET | /api/v1/websites/{website}/utm · goals | UTM 渠道与目标报表 |
资源管理
| 方法 | 端点 | 说明 |
|---|---|---|
| GET/POST/PUT/DELETE | /api/v1/websites/{website}/goals[/list][/{goal}[/detail]] | 转化目标增删改查 |
| GET/POST/PUT/DELETE | /api/v1/websites/{website}/heatmaps[/{heatmap}] | 热图增删改查 |
| GET/POST/PUT/DELETE | /api/v1/annotations · /api/v1/websites/{website}/annotations[/{annotation}] | 标注增删改查 |
| GET | /api/v1/websites/{website}/events-children[/list] | 事件子项(自动采集明细) |
| GET | /api/v1/websites/{website}/outbound-clicks[/list] | 出站点击 |
| GET | /api/v1/websites/{website}/goals-conversions[/{conversionId}] | 目标转化记录 |
| GET | /api/v1/logs/list · /api/v1/payments/list | 日志/支付独立列表 |
公开采集
| 方法 | 端点 | 说明 |
|---|---|---|
| POST | /api/v1/public/track | 像素数据上报(服务端采集) |
管理员 API
管理员端点需管理员账号,仅用于平台管理。
| 方法 | 端点 | 说明 |
|---|---|---|
| GET | /api/v1/admin/status · /statistics | 系统状态与统计 |
| GET/POST/PUT/DELETE | /api/v1/admin/users[/{userId}] | 用户管理 |
| GET/PUT/DELETE | /api/v1/admin/websites[/{websiteId}] | 网站管理 |
| GET/POST/PUT/DELETE | /api/v1/admin/plans[/{planId}] | 套餐管理 |
| GET | /api/v1/admin/payments[/{paymentId}] | 支付记录 |
| GET/PUT | /api/v1/admin/settings · /plugins[/{pluginId}] | 系统设置与插件 |
错误码
401 Unauthorized
API Key 缺失或无效
403 Forbidden
无权访问(需管理员)
404 Not Found
资源不存在或不属于你
422 Unprocessable
参数校验失败
429 Too Many
请求过于频繁(限流 60 次/分钟)
500 Server Error
服务器内部错误(查看 laravel.log)
还有疑问?
帮助中心收录使用教程与常见问题;登录后可提交工单联系管理员。