什么是 API 分析?

发布供外部使用的 API 只是 API 生命周期中的一个步骤。要更深入地了解 API 持续的业务和技术影响,需要强有力的 API 分析。开发人员成功采用 API 需要对 API 程序的所有操作方面进行监控和管理。

API 分析图

为什么要使用 API 分析?

  • 获得洞察驱动的结果:对生态系统的实时数据洞察,包括应用程序、消费、性能和使用指标(峰值、延迟、响应时间),以获得端到端的计划可见性
  • 管理风险:实时运营指标推动决策制定,并保护 API 程序免受网络攻击。
  • 改善客户体验:增进与客户(开发人员和 API 使用者)的关系,并根据数据洞察(衡量参与度和 API 性能)推动决策
  • 监控 KPI:跟踪和衡量跨产品、应用程序、渠道和位置的 API 使用情况。
API 分析资源
API 产品经理的权威成功指南
通过 7 部分成功指南了解公司如何创建 API 程序以发展数字业务,充分发挥 API 的强大性能!

常见问题

回答以下问题将有助于您改进 API 平台、解决问题并做出更好的业务决策:

  • 我的 API 流量表现如何?
  • 哪些 API 方法最受欢迎?
  • 谁是顶级 API 开发人员?
  • 是否存在阻碍响应时间的问题?
  • 哪里的 API 流量最多?

API 分析的好处

获取 API 性能的运营可见性

监控 API 使用趋势和模式,包括延迟、错误率、缓存性能、使用模式和调用峰值。在各种易于理解的仪表板中查看结果,以进行智能 API 分析。

了解您的 API 的使用方式

一目了然地看到谁在使用以及他们如何使用您的 API。API 分析可帮助您了解方法级别的使用情况,以发现采用和使用模式的趋势。

使用 API 调用跟踪进行故障排除

遇到 API 出错问题?使用我们的实时调用跟踪功能深入了解 API 调用流程,以帮助确定问题区域和故障点。

导出调用日志数据以供外部使用

顺其自然。将所有的 API 调用日志数据导出到 TIBCO Spotfire(或您选择的自定义 API 分析环境),然后将日志数据推送到计费软件,以通过您的 API 获利。

获取控制面板和报告数据的 API 访问权限

通过 API 报告工具访问现成可用的仪表板和报告中显示的任何数据,以进行编程导出和重复使用。

API 分析报告的类型

高级:执行摘要

执行摘要页面提供了应用程序编程接口 (API) 计划的高级视图,其中包含新的分析指标和趋势,以易于共享的格式供整个组织的执行利益相关者受众使用。

执行摘要旨在快速高效地提供一套全面的洞察,而无需执行任何数据收集和分析任务。执行摘要是对管理控制面板上现有报告的补充,并为广泛的受众设计,例如 API 管理员、API 产品经理、业务开发主管、市场营销主管和技术主管领导。

中级:报告

报告提供数据可视化,以帮助监控 API、软件包、计划、端点和开发人员的技术性能和业务指标。

用户访问报告可以:

  • 查看 API 使用情况摘要
  • 查看技术 API 性能数据
  • 查看开发者活动
  • 查看和分析 API 调用延迟
  • 查看和分析错误响应

低级:调用日志导出、调用日志流和调用检查器

调用记录导出

调用记录导出功能允许您访问和过滤原始 API 调用记录,并将其导出为 CSV 文件。新日志每 30 分钟发送一次,其中包含详细的 API 调用信息,例如源 IP 地址、URI、服务名称和端点名称。这些数据有许多可能的用例,包括细粒度计费、滥用检测和故障排除。

调用记录流

主调用日志流页面显示所有调用日志流频道记录的可导航列表。您可以访问以下信息:

  • 频道名称:调用记录流的频道名称;区域名称的默认名称为"频道"
  • 状态:频道的状态,“启用” 或 “已禁用”
  • 已创建:频道创建的日期和时间
  • 更新:频道上次更新的日期和时间

调用检查器

调用检查器是一项诊断功能,用于在 API 调用通过系统时对其进行跟踪。它提供了有关请求和响应在通过不同点时实际情况的详细信息。客户可以将调用检查器用于排除 API 调用问题或支持新集成等使用案例。通过启用指定端点和时间段的调用日志,可以捕获 API 调用数据。

API 分析指标

每个团队都希望跟踪不同的指标。基础设施团队的 API 指标将不同于产品团队的 API 指标。API 指标也可能取决于 API 产品的生命周期。例如,新的 API 将更多地侧重于改进设计和使用,而较旧的 API 可能会关注其他功能。

主要有四个依赖于 API 指标的组:

DevOps

DevOps 团队确保服务器正常运行,并正确分配有限的资源,可能用于多个工程团队。

有几个指标对这个团队很重要:

  • 正常运行时间
  • CPU 使用率
  • 内存使用情况

应用工程

API 开发人员向 API 添加了新功能,同时解决了 API 业务逻辑中的问题。他们开发插件、合作伙伴集成、合并的 API 等产品。

对这个团队来说重要的三个指标是:

  • 每分钟请求数 (RPM)
  • 平均和最大延迟
  • 每分钟错误数

产品管理

API 产品经理设计 API 功能,确保构建正确的端点,并在客户需求与时间限制之间取得平衡。

对这个团队来说很重要的一些指标是:

  • API 使用量增长
  • 独特的 API 客户
  • 按 API 使用情况排列的热门客户
  • API 保留
  • 首次使用的时间 (TTFHW)
  • 每笔业务交易的 API 调用次数
  • SDK 和版本采用

业务增长

市场营销和销售等面向业务的团队通常不会从 API 端点考虑问题。他们更感兴趣的是客户采用,看看哪些用户可以成为新的销售机会。

对这个团队来说重要的三个指标是:

  • 收入
  • 采用
  • 客户成功案例