服务器指标与统计

Tiptap 协作 API 提供多个端点，用于访问服务器和单个文档的实时统计和健康信息。云仪表板中还提供了简化版的指标。

这些端点有助于排查问题、监控服务器性能，或者构建分析仪表板，以洞察用户交互和系统状态。将统计信息整合到您的监控系统中，允许您主动管理协作环境的健康。

查看 Postman 集合

通过访问我们的 Postman 集合来实验 REST API。

访问 API

REST API 直接从您的文档服务器暴露，网址为您自定义的 URL：

https://YOUR_APP_ID.collab.tiptap.cloud/

身份验证

通过在 Authorization 头中包含 API 秘钥来验证您的 API 请求。您可以在 Tiptap Cloud 仪表板的设置中找到您的 API 秘钥。

文档标识符

如果您的文档标识符包含斜杠 (/)，请将其编码为 %2F，例如，使用 encodeURIComponent。

服务器统计端点

此端点提供有关 Tiptap 协作服务器的基本统计数据，提供有关整体活动和使用指标的洞察。

GET /api/statistics

注意

过去 30 天的连接总数和生命周期连接计数以字符串形式呈现，因为它们内部表示为 BigInt 值。

示例： 服务器统计

{
  "totalDocuments": 4,
  "totalConnections30d": "3",
  "maxConcurrentConnections30d": 3,
  "lifetimeConnections": "144",
  "currentConnectionsCount": 3,
  "currentLoadedDocumentsCount": 1,
  "openDocuments": ["testdocument"],
  "connectionsPerDocument": {
    "testdocument": 3
  },
  "version": "3.33.0"
}

文档统计端点

通过标识符检索特定文档的统计信息。使用此端点监控用户与文档的实时互动。

GET /api/documents/:identifier/statistics

示例： 名为 :identifier 的文档统计

{
  "currentConnections": 2,
  "connectedIps": ["127.0.0.1", "10.100.1.23"]
}

服务器健康端点

使用此调用检查与数据库和 Redis 等重要组件的存活性、就绪性和连接性。

GET /health

示例： Redis 出现问题

HTTP 500:

DB:ok
REDIS:fail

示例： 未检测到 Redis

HTTP 200:

DB:ok
REDIS:inactive