网站统计

关于网站统计的操作。

端点

GET /api/websites/:websiteId/active
GET /api/websites/:websiteId/daterange
GET /api/websites/:websiteId/events/series
GET /api/websites/:websiteId/metrics
GET /api/websites/:websiteId/metrics/expanded
GET /api/websites/:websiteId/pageviews
GET /api/websites/:websiteId/stats

过滤器

所有标记为 filters 的端点现在可以使用以下参数进行过滤。

Parameter	Type	Description
`path`	string	URL 的名称。
`referrer`	string	引荐来源的名称。
`title`	string	页面标题的名称。
`query`	string	查询参数的名称。
`browser`	string	浏览器名称。
`os`	string	操作系统名称。
`device`	string	设备名称（例如：移动设备）。
`country`	string	国家名称。
`region`	string	地区/州/省名称。
`city`	string	城市名称。
`language`	string	浏览器语言的名称。
`hostname`	string	主机名的名称。
`tag`	string	标签名称。
`event`	string	事件名称。
`distinctId`	string	distinct ID 的名称。
`utmSource`	string	UTM 来源。
`utmMedium`	string	UTM 媒介。
`utmCampaign`	string	UTM 活动名称。
`utmContent`	string	UTM 内容。
`utmTerm`	string	UTM 术语。
`segment`	uuid	分段的 UUID。
`cohort`	uuid	同群组的 UUID。

单位参数

单位参数用于对返回的数据进行分组。如果超过最大值，单位会自动转换为下一个较大的适用时间单位。

Unit	Maximum
`minute`	最多 60 分钟。
`hour`	最多 30 天。
`day`	最多 6 个月。
`month`	无限制。
`year`	无限制。

GET /api/websites/:websiteId/active

获取网站上的活跃用户数量。

示例响应

{
  "visitors": 5
}

visitors：最近 5 分钟内的独立访客数量

GET /api/websites/:websiteId/daterange

获取网站可用数据的日期范围。

示例响应

{
    "startDate": "2025-12-06T00:00:00Z",
    "endDate": "2026-03-11T21:00:00Z"
}

GET /api/websites/:websiteId/events/series

获取给定时间范围内的事件。

参数

Parameter	Type	Description
`startAt`	number	开始日期的时间戳（毫秒）。
`endAt`	number	结束日期的时间戳（毫秒）。
`unit`	string	时间单位（`year` \| `month` \| `hour` \| `day`）。
`timezone`	string	时区（例如 America/Los_Angeles）。
`filters`	object	可以接受过滤参数。

示例响应

[
  {
    "x": "live-demo-button",
    "t": "2023-04-12T22:00:00Z",
    "y": 1
  },
  {
    "x": "get-started-button",
    "t": "2023-04-12T22:00:00Z",
    "y": 5
  },
  {
    "x": "get-started-button",
    "t": "2023-04-12T23:00:00Z",
    "y": 4
  },
  {
    "x": "live-demo-button",
    "t": "2023-04-12T23:00:00Z",
    "y": 4
  },
  {
    "x": "social-Discord",
    "t": "2023-04-13T00:00:00Z",
    "y": 1
  }
]

Field	Description
`x`	事件名称。
`t`	时间戳。
`y`	事件数量。

GET /api/websites/:websiteId/metrics

获取给定时间范围内的指标。

参数

Parameter	Type	Description
`startAt`	number	开始日期的时间戳（毫秒）。
`endAt`	number	结束日期的时间戳（毫秒）。
`type`	string	指标类型。
`filters`	object	可以接受过滤参数。
`limit`	number	（可选，默认 500）返回的行数。
`offset`	number	（可选，默认 0）跳过的行数。

可用类型

示例响应

[
  {
    "x": "Mac OS",
    "y": 1918
  },
  {
    "x": "Windows 10",
    "y": 1413
  },
  {
    "x": "iOS",
    "y": 464
  },
  {
    "x": "Android OS",
    "y": 301
  },
  {
    "x": "Linux",
    "y": 296
  },
  {
    "x": "Windows 7",
    "y": 29
  },
  {
    "x": "Chrome OS",
    "y": 12
  }
]

Field	Description
`x`	唯一值，取决于指标类型。
`y`	访客数量。

GET /api/websites/:websiteId/metrics/expanded

获取给定时间范围内的扩展指标。

参数

Parameter	Type	Description
`startAt`	number	开始日期的时间戳（毫秒）。
`endAt`	number	结束日期的时间戳（毫秒）。
`type`	string	指标类型。
`filters`	object	可以接受过滤参数。
`limit`	number	（可选，默认 500）返回的行数。
`offset`	number	（可选，默认 0）跳过的行数。

可用类型

示例响应

[
  {
    "name": "Mac OS",
    "pageviews": 74020,
    "visitors": 16982,
    "visits": 24770,
    "bounces": 15033,
    "totaltime": 149156302
  },
  {
    "name": "Windows 10",
    "pageviews": 52252,
    "visitors": 12858,
    "visits": 20089,
    "bounces": 12720,
    "totaltime": 137208105
  },
  {
    "name": "iOS",
    "pageviews": 10029,
    "visitors": 4364,
    "visits": 5139,
    "bounces": 3578,
    "totaltime": 23482267
  },
  {
    "name": "Android OS",
    "pageviews": 8147,
    "visitors": 3122,
    "visits": 3854,
    "bounces": 2610,
    "totaltime": 20347972
  },
  {
    "name": "Linux",
    "pageviews": 12462,
    "visitors": 3000,
    "visits": 4278,
    "bounces": 2630,
    "totaltime": 26331069
  }
]

Field	Description
`name`	唯一值，取决于指标类型。
`pageviews`	页面访问量。
`visitors`	独立访客数量。
`visits`	独立访问次数。
`bounces`	仅访问单个页面的访客数量。
`totaltime`	网站上的停留时间。

GET /api/websites/:websiteId/pageviews

获取给定时间范围内的页面浏览量。

参数

Parameter	Type	Description
`startAt`	number	开始日期的时间戳（毫秒）。
`endAt`	number	结束日期的时间戳（毫秒）。
`unit`	string	时间单位（`year` \| `month` \| `hour` \| `day`）。
`timezone`	string	时区（例如 America/Los_Angeles）。
`compare`	string	（可选）比较周期（`prev` \| `yoy`）。
`filters`	object	可以接受过滤参数。

示例响应

{
  "pageviews": [
    {
      "x": "2025-10-19T07:00:00Z",
      "y": 4129
    },
    {
      "x": "2025-10-20T07:00:00Z",
      "y": 6105
    },
    {
      "x": "2025-10-21T07:00:00Z",
      "y": 4936
    }
  ],
  "sessions": [
    {
      "x": "2025-10-19T07:00:00Z",
      "y": 1397
    },
    {
      "x": "2025-10-20T07:00:00Z",
      "y": 1880
    },
    {
      "x": "2025-10-21T07:00:00Z",
      "y": 1469
    }
  ]
}

x：时间戳。
y：页面浏览量或访客数。

GET /api/websites/:websiteId/stats

获取网站汇总统计数据。

参数

Parameter	Type	Description
`startAt`	number	开始日期的时间戳（毫秒）。
`endAt`	number	结束日期的时间戳（毫秒）。
`filters`	object	可以接受过滤参数。

示例响应

{
  "pageviews": 15171,
  "visitors": 4415,
  "visits": 5680,
  "bounces": 3567,
  "totaltime": 809968,
  "comparison": {
    "pageviews": 38675,
    "visitors": 10568,
    "visits": 14595,
    "bounces": 9364,
    "totaltime": 2182387
  }
}

Field	Description
`pageviews`	页面访问量。
`visitors`	独立访客数量。
`visits`	独立访问次数。
`bounces`	仅访问单个页面的访客数量。
`totaltime`	网站上的停留时间。

On this page