端点
会话
On this page
关于会话及会话数据的操作。
端点
GET /api/websites/:websiteId/sessions
GET /api/websites/:websiteId/sessions/stats
GET /api/websites/:websiteId/sessions/:sessionId
GET /api/websites/:websiteId/sessions/:sessionId/activity
GET /api/websites/:websiteId/sessions/:sessionId/properties
GET /api/websites/:websiteId/session-data/properties
GET /api/websites/:websiteId/session-data/values
获取给定时间范围内的网站会话详情。
参数
startAt: 开始日期的时间戳（毫秒）。endAt: 结束日期的时间戳（毫秒）。query: （可选字符串）搜索文本。page: （可选数字，默认为1）确定页码。pageSize: （可选字符串）确定返回多少条结果。orderBy: （可选字符串）按列名排序。示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/sessions?page=1&startAt=1725865200000&endAt=1725951599999&pageSize=20
{
"data": [
{
"id": "5a45d799-e6f5-56ac-9893-fde6f769c36a",
"websiteId": "86d4095c-a2a8-4fc8-9521-103e858e2b41",
"hostname": "umami.is",
"browser": "chrome",
"os": "Windows 10",
"device": "laptop",
"screen": "1536x960",
"language": "en-US",
"country": "US",
"subdivision1": "US-CA",
"city": "Roseville",
"firstAt": "2024-09-09T17:44:35Z",
"lastAt": "2024-09-09T17:44:35Z",
"visits": 1,
"views": 1,
"createdAt": "2024-09-09T17:44:35Z"
},
{
"id": "753ce23b-0dab-5a33-badc-4d2239528dd9",
"websiteId": "86d4095c-a2a8-4fc8-9521-103e858e2b41",
"hostname": "umami.is",
"browser": "chrome",
"os": "Windows 10",
"device": "desktop",
"screen": "2560x1440",
"language": "de-DE",
"country": "DE",
"subdivision1": "DE-BY",
"city": "Munich",
"firstAt": "2024-09-09T08:54:18Z",
"lastAt": "2024-09-09T17:44:29Z",
"visits": 5,
"views": 66,
"createdAt": "2024-09-09T17:44:29Z"
}
],
"count": 1000,
"page": 1,
"pageSize": 20
}
获取概述的网站会话统计信息。
参数
startAt: 开始日期的时间戳（毫秒）。endAt: 结束日期的时间戳（毫秒）。url: （可选）URL名称。referrer: （可选）引荐来源名称。title: （可选）页面标题名称。query: （可选）查询名称。event: （可选）事件名称。host: （可选）主机名。os: （可选）操作系统名称。browser: （可选）浏览器名称。device: （可选）设备名称（如手机）。country: （可选）国家名称。region: （可选）区域/省/州名称。city: （可选）城市名称。示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/sessions/stats?startAt=1656679719687&endAt=1656766119687
{
"pageviews": { "value": 3018 },
"visitors": { "value": 847 },
"visits": { "value": 984 },
"countries": { "value": 537 },
"events": { "value": 150492 }
}
pageviews: 页面点击数visitors: 唯一访客数量visits: 会话数量countries: 唯一国家数量events: 自定义事件数量获取单个会话的详情
参数
无
示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/sessions/a35fe227-2fe9-5147-85a0-15f0fd48faed
{
"id": "a35fe227-2fe9-5147-85a0-15f0fd48faed",
"websiteId": "86d4095c-a2a8-4fc8-9521-103e858e2b41",
"hostname": "umami.is",
"browser": "ios",
"os": "iOS",
"device": "mobile",
"screen": "390x844",
"language": "en-US",
"country": "US",
"subdivision1": "US-IN",
"city": "Bloomington",
"firstAt": "2024-09-09T18:12:01Z",
"lastAt": "2024-09-09T18:12:08Z",
"visits": 1,
"views": 3,
"events": 0,
"totaltime": 7
}
获取单个会话的活动记录
参数
startAt: 开始日期的时间戳（毫秒）。endAt: 结束日期的时间戳（毫秒）。示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/sessions/a35fe227-2fe9-5147-85a0-15f0fd48faed/activity?startAt=1725905521000&endAt=1725905528000
[
{
"createdAt": "2024-09-09T18:12:08Z",
"urlPath": "/websites/fd4bdd56-2135-4c42-9518-55e72669f23c",
"urlQuery": "",
"referrerDomain": "",
"eventId": "a154aebc-10cf-4a26-8187-c541ef0d2929",
"eventType": 1,
"eventName": "",
"visitId": "609a5116-b139-5c6d-9293-fbea9b8a3b61"
},
{
"createdAt": "2024-09-09T18:12:01Z",
"urlPath": "/settings/websites",
"urlQuery": "",
"referrerDomain": "",
"eventId": "92246b7b-e3e2-4c9d-b61e-fab69d993ad7",
"eventType": 1,
"eventName": "",
"visitId": "609a5116-b139-5c6d-9293-fbea9b8a3b61"
}
]
获取单个会话的属性
参数
无
示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/sessions/a35fe227-2fe9-5147-85a0-15f0fd48faed/properties
[
{
"websiteId": "1ccddccf-7d34-432b-84e6-e46903b2acf3",
"sessionId": "a35fe227-2fe9-5147-85a0-15f0fd48faed",
"dataKey": "email",
"dataType": 1,
"stringValue": "johndoe@gmail.com",
"numberValue": null,
"dateValue": null,
"createdAt": "2024-09-09T18:12:01Z"
},
{
"websiteId": "1ccddccf-7d34-432b-84e6-e46903b2acf3",
"sessionId": "a35fe227-2fe9-5147-85a0-15f0fd48faed",
"dataKey": "name",
"dataType": 1,
"stringValue": "John Doe",
"numberValue": null,
"dateValue": null,
"createdAt": "2024-09-09T18:12:01Z"
}
]
按属性名称获取会话数据计数
参数
startAt: 开始日期的时间戳（毫秒）。endAt: 结束日期的时间戳（毫秒）。示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/session-data/properties?startAt=1717916400000&endAt=1725692399999
[
{
"propertyName": "id",
"total": 1039
},
{
"propertyName": "region",
"total": 1039
},
{
"propertyName": "name",
"total": 1039
},
{
"propertyName": "email",
"total": 1039
}
]
获取给定属性的会话数据计数
参数
startAt: 开始日期的时间戳（毫秒）。endAt: 结束日期的时间戳（毫秒）。propertyName: 属性名称。示例响应
URL: https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/session-data/values?startAt=1717916400000&endAt=1725692399999&propertyName=region
[
{ "value": "EU", "total": 609 },
{ "value": "US", "total": 431 }
]