API
报告适用于所有 Postman Enterprise 和部分 Postman Professional
计划。
Postman 生成报告,使您能够可视化团队指标和使用情况的数据,以及 API 活动(例如创建、集合执行和测试运行)的数据。使用报告深入了解性能、故障排除和
SLA 遵守情况。您可以在Postman 仪表板中访问 API 报告。
开始使用报告
要在 Postman 中查看 API 报告,请确保执行以下所有操作:
- 分享您的 API。
- 向 API 添加一个集合。
- 在左侧边栏中选择History并启用Save Responses选项。
- 从集合发送请求。
查看报告:
- 在 Postman 标题中选择报告以查看所有报告。
- 要查看特定 API 的报告,请转到 API 的概述页面并选择报告。
报告是定期生成的,但不是实时生成的。在报告数据可用之前,您可能会遇到几分钟或最多 24 小时的延迟。最后更新时间显示在左侧边栏的底部。
您只能查看根据您的角色对您可见的报告数据。
在报告中导航:
- 选择左侧边栏中的项目以查看每个报告。
- 某些报告项目具有打开另一个相关报告的链接。例如,在摘要报告的正常运行时间图表上,有一个用于打开团队
API报告的链接。
- 将鼠标悬停在数据点上以显示数据点的值。
- 选择一个数据点以向下钻取并查看更多详细信息。通过选择列标题对表格进行排序。将鼠标悬停在表格行上并选择箭头以导航到相关报表或实体。
Postman Enterprise团队可以访问详细的团队和 API 报告。2020 年之后创建的
Postman Professional 团队可以访问一组有限的报告。有关详细信息,请参阅Postman
Professional 报告。
报告摘要
报告摘要仪表板显示您的 API 概览,以及您的团队如何使用 Postman 以及人们如何与您公开共享的工作进行交互的快照。
您的 API 的摘要视图
- 概述- API 的总数,加上带有模拟、监视器、测试和文档的 API 数量的细分,以及私有和公共
API 网络上的 API 数量。
- 响应时间- 一段时间内所有 API 的平均响应时间(以毫秒为单位)。
- 测试结果- 随着时间的推移成功和失败的测试运行次数。
- 正常运行时间- 随着时间的推移,成功响应(返回 1xx 或 2xx)与失败响应(返回 3xx、4xx
或 5xx)相比的数量。
您的团队如何使用 Postman?
- 团队活动- 一段时间内工作空间中的用户操作总数(创建、编辑和删除实体,例如请求、集合、API
和环境)。
- 资源使用- 团队中使用和未使用的集成、模拟调用、监控请求和 Postman API 调用的数量。
人们如何与您公开共享的作品互动
- 公开个人资料查看次数- 人们查看您团队中任何公开个人资料的总次数。
- 公共工作区视图- 团队公共工作区随时间的视图数量。
- 已发布的文档视图- 您的团队在一段时间内发布的文档的视图数量。
- 随着时间的推移分叉和拉取请求- 随着时间的推移,公共工作区中的集合被分叉或拉取的次数。
- 随时间观看- 随着时间的推移,某人在您的公共工作区观看收藏集的次数。
团队报告
团队报告 提供团队级别的指标,包括团队概览、团队规模、计费详细信息、团队活动和工作区。本节包含三个报告:
团队详情
团队详细信息报告提供您的团队和成员的概览,包括:
- 团队名称- 您的团队的名称。
- 团队创建日期- 创建团队的日期。
- 计划类型-您的团队当前订阅的Postman 计划。
- 团队成员总数- 团队中的当前用户帐户数。
- 随时间变化的团队成员- 随时间变化的团队规模。
- 团队角色- 具有管理员、计费、社区经理或开发者角色的团队成员数量。
- SSO 身份提供者-您为团队成员配置的任何单点登录提供者,以访问他们的 Postman 帐户。
- 计费周期- 您帐户的计费周期(每年或每月)。
- 续订日期- 您当前的 Postman 计划将续订的日期。
团队活动
团队活动报告提供有关团队成员活动的更多详细信息,包括:
- 团队成员总数- 团队中的当前用户帐户数。
- 一段时间内的活跃成员- 当天至少使用 Postman 一次的团队成员数量。
- 团队活动- 一段时间内工作空间中的用户操作总数(创建、编辑和删除实体,例如请求、集合、API
和环境)。
- 随时间创建的实体 - 随时间创建的实体数量,包括 API、集合、环境、模拟和监视器。
- 随着时间的推移对实体的更新- 随着时间的推移对实体所做的更改。
资源使用
资源使用报告提供有关您的团队如何使用 Postman 资源的更多信息,包括:
- 团队插槽- 整个团队的计费插槽使用情况。
-
已用插槽- 与您的团队未使用的已计费插槽相比,已使用的计费插槽。
- 未开票槽- 未开票槽的数量。
- 随时间使用的时隙- 已计费时隙、未计费时隙和总可用时隙随时间变化。
- 模拟服务器调用- 随着时间的推移模拟服务器调用、超额调用和模拟调用。
- 监控服务器呼叫- 监控呼叫、超额呼叫和监控呼叫随着时间的推移。
- Postman API 调用- 对 Postman API 进行的 API 调用次数。
- 集成- 创建的集成、实体上的集成以及按类型的集成。
所有工作区报告
所有工作区报告都提供有关公共和私人工作区的指标。本节包含三个报告:
所有工作区
所有工作区摘要报告包含以下内容:
- 工作区总数- 工作区总数,包括团队、个人和私人工作区。
- 随时间创建的工作空间 - 您的团队随时间创建的工作空间总数。
- 按类型划分的工作区- 个人、私人、公共和团队工作区的总数,以及每种类型的空工作区数量。
- 一段时间内的活动工作区- 当天至少有一个修订版的工作区数量。
团队工作区
团队工作区报告包含团队工作区的以下信息:
- 团队工作区总数- 您的团队的团队工作区总数。
- 最活跃的团队工作区- 指向过去 30 天内最活跃的团队工作区的链接。
- 团队工作区中的实体- 所有团队工作区中的环境、监视器、模拟、集合和 API 的数量。
- 随着时间的推移分叉和拉取请求- 团队工作区中的集合随着时间的推移被分叉或拉取的次数。
- 随时间观看- 随着时间的推移,某人在您的团队工作区中观看收藏集的次数。
- 一段时间内的评论- 一个人在一段时间内对团队工作区中的集合发表评论的次数。
公共工作空间
公共工作区报告包含公共工作区的以下信息:
- 公共工作区总数- 团队的公共工作区总数。
- 最活跃的公共工作区- 指向过去 30 天内最活跃的公共工作区的链接。
- 浏览次数最多的公共工作区- 指向过去三个月浏览次数最多的公共工作区的链接。
- 工作区和集合视图- 随着时间的推移,公共工作区中的工作区和集合视图的数量。
- 公共工作区中的实体- 团队公共工作区中的环境、监视器、模拟、集合和 API 的数量。
- 随着时间的推移分叉和拉取请求- 随着时间的推移,公共工作区中的集合被分叉或拉取的次数。
- 随时间观看- 随着时间的推移,某人在您的公共工作区观看收藏集的次数。
- 随时间变化的评论- 一个人随时间对公共工作区中的集合发表评论的次数。
所有 API 报告
所有 API报告提供所有 API的概览以及团队、专用网络和公共 API 的单独报告。它还使您能够查看每个
API 的详细报告。
- 所有 API 概览
- 团队 API
- 专用网络 API
- 公共 API
- 按 API 查看报告
所有 API 概览
所有 API概览报告提供以下信息:
- API 总数- 您的团队在所有工作区中创建的 API 总数。
- API 分布- 在个人、私有、团队或公共工作区或私有 API 网络中创建的 API 数量。
- 一段时间内创建的 API - 每月创建的 API 总数。
团队 API
团队 API报告提供有关您的团队创建的 API 的信息,包括:
- 团队工作区中的 API总数- 团队工作区中的 API 数量。
- Schemas by type - 按模式类型(OpenAPI、GraphQL、Swagger
等)划分的 API 数量。
- API 随时间更新- 随时间更新的 API 数量。
- 响应时间- 所有 API 在一段时间内的平均响应时间。
- 测试结果- 随着时间的推移成功和失败的测试运行次数。
- 正常运行时间- 随着时间的推移,成功响应(返回 1xx 或 2xx)与失败响应(返回 3xx、4xx
或 5xx)相比的数量。
- 带有 Mocks的 API - 您的团队添加了 mock 的 API 数量。
- 带有监视器的 API - 您的团队已添加监视器的 API 数量。
- 带有测试的 API - 您的团队已添加测试的 API 数量。
- 带有文档的 API - 您的团队已添加文档的 API 数量。
- Watches API - 一段时间内的观看次数。
- 一段时间内的评论数 - 一段时间内的评论数。
专用网络 API
专用网络 API报告提供的指标包括总已发布 API 的概述、按架构类型分类的 API 可视化,以及带有和不带有模拟、监视器、测试和文档的
API 的单独视图。
专用网络 API报告提供以下信息:
- 私有 API 网络上的 API 总数- 发布到私有 API 网络的 API 数量。
- Schemas by type - 按模式类型(OpenAPI、GraphQL、Swagger
等)划分的 API 数量。
- 带有模拟的 API - 您的团队已添加模拟的 API 数量。
- 带有监视器的 API - 您的团队已添加监视器的 API 数量。
- 带有测试的 API - 您的团队已添加测试的 API 数量。
- 带有文档的 API - 您的团队已添加文档的 API 数量。
- 一段时间内的观看次数 - 一段时间内的观看次数。
- 一段时间内的评论数 - 一段时间内的评论数。
公共 API
公共 API报告提供的指标包括总已发布 API、API 更新和视图的概览,以及带有和不带有模拟、监视器、测试和文档的
API 的单独视图。
公共 API报告提供与私有 API报告相同的信息,但不包括按类型划分的模式。它还包括以下内容:
- API 随时间更新- 随时间更新的 API 数量。
- 浏览次数最多的公共 API - 指向您团队过去三个月浏览次数最多的公共 API 的链接。
- 公共 API 视图- 您的团队的公共 API 视图数量随时间变化的图表。
按 API 查看报告
按 API 查看报告为每个单独的 API 提供报告。滚动 API 列表,或使用搜索框查找 API,然后选择
API 以查看报告。每个 API 报告都包含以下信息:
- API 名称- API 的名称
- API 创建者- 创建 API 的用户
- API 创建日期- API 创建日期
- API 请求数 - 一段时间内向 API 发出的请求数。
- 失败的测试运行- 一段时间内失败的测试运行总数。
- 平均响应大小- 一段时间内的平均响应大小(以字节为单位)。
- 平均响应时间- 一段时间内的平均响应时间(以毫秒为单位)。
- API 响应代码- 每个 API 响应的 HTTP 响应代码。
安全审计报告
安全审计报告提供的指标包括您扫描的总集合的概述、具有暴露令牌的集合、总暴露令牌,以及按类型和随时间变化的暴露令牌的单独可视化。本报告整合了来自公共文档的
Postman 令牌扫描程序的发现。了解有关 Postman令牌扫描仪的更多信息。
安全审计报告提供以下信息:
- 扫描的集合总数- 已发布或更新的集合数量。
- 带有暴露令牌的集合 - 具有暴露令牌的集合扫描的总数。
- 公开的令牌总数- 在所有已发布集合中公开的令牌总数。
- 按类型公开的令牌 - 按类型公开的令牌数。
- 随着时间的推移暴露的令牌- 随着时间的推移暴露的令牌数量。
邮递员专业报告
在 2020 年 1 月之后创建的 Postman Professional 团队不会从 API
报告中受益。要访问 API 报告,请升级到 Postman Enterprise。有关您团队的计划和功能集的信息和帮助,请联系
Postman 支持。
Team > Overview报告提供组织级别的指标,包括新的和活动的 API、团队规模和工作区。选择特定指标以查看更多数据。
团队报告
团队报告提供以下信息:
- 团队中存在的 API 总数,包括私有和公共工作区中的 API。
- 团队内部创建的新 API ,不包括新版本。
- 通过 Postman 请求构建器中的链接集合发送至少一个请求的活动 API 。
- 团队规模为团队中用户帐户的数量。
- 没有集合的空工作区。
- 在过去 24 小时内至少有一次修订的活动工作区,不包括个人工作区。
团队 API 请求是在一段时间内发送的请求计数。汇总平均值是通过考虑所有天数来计算的(即使一天内没有发送请求)。
API 报告
API 报告提供数据的图形表示,使您能够按收集和持续时间(过去 7 天或 30 天)过滤数据。您可以查看已链接到
API 的任何单个集合的报告。
报告仅跟踪您已共享到团队工作区的 API 中的数据。如果您的 API 仅共享到个人工作区,您将看不到它的报告。
API 报告提供以下信息:
- 请求的平均响应大小(以字节或千字节为单位)。
- API 服务请求的平均响应时间。
- 指示 API 返回的错误代码的错误响应数。
- Postman 中的流量指示用于性能测量的使用情况和 API 流量。
- 失败的测试运行指示收集运行和监视器中失败的测试数量,用于调试和排除请求中的错误。
平均响应大小是根据响应大小和特定日期发送的请求数计算得出的。
平均响应时间是根据返回请求响应所需的时间和特定日期发送的请求数计算得出的。
摘要平均响应大小可能与图表的平均值不匹配,因为在计算平均值时会考虑原始数据。为了确定准确的平均值,Postman
不会使用来自已经得出的平均值的数据来计算平均值。
失败的测试运行是一段时间内收集运行的失败测试数。汇总平均值是通过考虑该时间段内的所有天数来计算的(即使在某些天没有发送请求)。
故障排除
报告有以下限制:
- 您不能下载或导出您的报告。
- Postman 报告跟踪仅通过请求生成器发送的数据,而不是通过 Newman、收集运行或监视器发送的数据。但是,失败的测试运行会使用收集运行生成报告。
- 您无法查看您无权访问的实体的详细信息。
如果您在报告中看不到任何数据,或者您的数据不完整(例如,您的响应时间或大小为空),这可能是由于以下原因之一:
- 现在检查还为时过早。数据每四个小时刷新一次。
- 您可能没有将集合链接到您的 API。
- 您可能尚未发送请求,或者您可能已执行来自监控、收集运行或 Newman 的请求,但不是来自
- Postman 中的请求构建器。
- 您可能没有在 Postman的历史选项卡中启用保存回复。
- Sync 未成功与 Postman 服务器通信。检查您的网络连接,并访问Postman 状态页面以查看当前是否存在中断。
下一步
您可以使用监视器来详细了解您的 API。
|