生成获利报告

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

您可以使用 Apigee 的自定义报告功能生成报告,以查看您的 API 的获利信息。您可以使用 Apigee 界面、Stats API 或 Queries API 来生成报告,如以下各部分所述:

获利指标和维度

Apigee 提供以下获利指标和维度:

  • 适用于使用 API 代理的事务的指标和维度
  • 基于费用的事务的指标和维度

适用于使用 API 代理的事务的指标和维度

下表列出了适用于使用 API 代理的事务的 x_apigee_mintng_* 指标和维度:

  • 指标
    界面中的名称 API 中的名称 说明
    API 价格系数 x_apigee_mintng_price_multiplier 每事务费用需要与这一倍数(系数)相乘。
    开发者收益分成 x_apigee_mintng_dev_share 开发者在一个事务的收益中的分成。
    获利价格 x_apigee_mintng_price 一个事务的总收益。
    获利费率 x_apigee_mintng_rate 对一个事务收取的费率。
  • 维度
    界面中的名称 API 中的名称 说明
    收益币种 x_apigee_mintng_currency 事务收益采用的币种。
    事务成功 x_apigee_mintng_tx_success 事务的获利状态。

基于费用的事务的指标和维度

下表列出了仅适用于基于费用的事务的指标和维度:

  • 指标
    界面中的名称 API 中的名称 说明
    费用 费用 表示设置费用、周期性费用和预付款充值的金额。
  • 维度
    界面中的名称 API 中的名称 说明
    API 产品 api_product 设置费用、周期性费用或预付款充值的费率方案所对应的 API 产品。对于预付款充值,该值为空。
    开发者电子邮件地址 developer_email 需要支付设置费用、周期性费用或预付款充值的开发者。
    费用类型 fees_type 费用类型。可以是设置费用、周期性费用或预付款充值。与 fees 以外的任何指标搭配使用时,此维度将为 null
    时期结束 period_end

    目前适用于 Apigee 组织,不适用于 Apigee Hybrid 组织。

    周期性费用扣款期的结束时间。例如,对于每月费用来说,这是当月的最后一天。

    时期开始 period_start

    目前适用于 Apigee 组织,不适用于 Apigee Hybrid 组织。

    周期性费用扣款期的开始时间。例如,对于每月费用来说,这是当月的第一天。

    收入货币 x_apigee_mintng_currency 设置费用、周期性费用或预付款充值的货币。
    费率方案 ID x_apigee_mintng_rate_plan_id

    目前适用于 Apigee 组织,不适用于 Apigee Hybrid 组织。

    应用开发者的获利费率方案。

如需详细了解这些指标和维度,请参阅分析指标、维度和过滤条件参考文档

以下示例自定义报告显示了所有开发者应用的获利费率总和

显示获利费率总和的自定义报告结果

对于每个开发者应用,该示例报告显示了 1-Apr-2021 to 15-Apr-2021 期间所有事务的总费用。该费用根据费率方案中配置的基于用量的价格计算。请注意,在此示例中,指标 (x_apigee_mintng_rate) 是获利字段,但维度 (developer_app) 是非获利字段。因此,您可以根据需求结合使用获利字段和非获利字段生成报告。

您还可以使用过滤条件根据指标特征限制结果。

导出创收分析数据

在 Apigee 中,您无需执行任何其他步骤即可导出创收分析数据。如果您要导出分析数据,则 Apigee 会导出以下创收字段以及常规分析数据。将基于费用的事务和使用 API 代理的事务一起导出时,每个记录都会导出通用的指标和维度,其他(非相关)指标和维度则设置为 NULL。
  • client_received_start_timestamp
  • period_end
  • period_start
  • x_apigee_mintng_currency
  • x_apigee_mintng_dev_share
  • x_apigee_mintng_price
  • x_apigee_mintng_price_multiplier
  • x_apigee_mintng_rate
  • x_apigee_mintng_rate_plan_id
  • x_apigee_mintng_tx_success