此页面由 Cloud Translation API 翻译。

管理报告

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。信息

简介

通过创收报告，您可以访问重点使用情况信息和交易活动。例如，您可以确定哪些应用、开发者、API 产品捆绑包或 API 产品特定日期范围内的交易活动借助获利功能，您可以生成摘要或用于跟踪 API 使用情况的详细报告。

创收报告的类型

您可以生成以下类型的创收报告。

报告	说明
结算	查看开发者在一个结算月份的活动，并验证费率已正确应用
预付余额	查看已预付款开发者在结算月份或以便核对通过您的付款处理方。
收入	查看开发者在特定日期范围内的活动和收入，以便了解分析您的 API 产品包和产品在开发者（及其应用）。注意：收入报告包含截至日期早于通过 `toDate` 配置选项指定的结束日期。在指定结束日期收集的报告数据将从报告中排除。收入报告中的开发者名称是开发者的法定名称。您可以使用 `MINT_DEVELOPER_LEGAL_NAME` 自定义属性配置开发者法定名称，如配置创收属性。如果开发者的法定名称不可用，Apigee 会将开发者名称设置为开发者姓名（名字 + 姓氏）。假设也未指定开发者的名称；Apigee 将开发者名称更改为“`NA`”。
方差	差异报告已弃用，只能使用传统版 Edge 界面进行配置。在未来的版本中，差异报表将被停用。比较开发者在两个日期范围内的活动和收入，以便了解可以分析 API 套餐和产品的表现上升或下降趋势开发者（及其应用）之间的任何互动

数据保留简介

在 Apigee Edge 公有云中，创收数据保留是一项方案权限。请参阅变现权益，详见 https://cloud.google.com/apigee/specsheets。如果您想在使用权之外保留变现数据，请与 Apigee 销售团队联系。延长数据保留期会在提出请求时启用，且不可保留可追溯启用，以包含早于原始数据保留期限的数据。

关于重复交易

如果您将创收交易报告与 Google Analytics 数据进行比较，可能会发现一个小小的重复交易的数量。这是正常现象，因为创收系统每天处理数百万个交易，同时并行处理许多交易特定时刻。平均而言，大约 0.1% 的交易可能是重复的。

探索“创收报告”页面

访问“创收报告”页面（如下所述）。

边缘

如需使用 Edge 界面访问“报告”页面，请执行以下操作：

登录 apigee.com/edge。
选择发布 >创收 >报告。

此时会显示“报告”页面。

如图所示，您可以通过“报告”页面执行以下操作：

查看所有报告的摘要信息，包括报告名称和说明、报告类型、日期范围以及上次修改日期。
配置报告
以 CSV 或 ZIP 文件格式生成并下载报告
修改报告
删除报告
搜索报告列表

传统 Edge（私有云）

如需使用传统版 Edge 界面访问“报告”页面，请执行以下操作：

登录 http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
选择创收 >创收报告。

此时会显示“报告”页面。

查看当前的报告列表
配置报告
以 CSV 格式生成并下载报告
修改报告
删除报告

配置报告

按照以下部分所述，使用界面配置报告。

配置报告的步骤

使用 Edge 界面或传统版 Edge 界面配置报告。

Edge

如需使用 Edge 界面配置报告，请执行以下操作：

选择发布 >创收 >报告。
点击 + 举报

配置下表中定义的报告详细信息。

字段	说明
名称	报告的唯一名称。
说明	报告的说明。
报告类型	请参阅创收报告的类型。

根据所选的报告类型配置剩余的报告详细信息，如以下部分所述： <ph type="x-smartling-placeholder">
在报告窗口中输入信息后，您可以： <ph type="x-smartling-placeholder">
- 点击保存报告以保存报告配置。
- 如果只想查看详细报告，请点击提交作业以异步方式生成报告并在稍后检索结果。有关详情，请参阅生成和下载报告。
- 点击另存为 CSV 或另存为 ZIP 文件，将生成的报告以逗号分隔值 (CSV) 或包含 CSV 文件的压缩 ZIP 文件。推荐用于 Zip 下载而且下载效率也会更高

传统 Edge（私有云）

如需使用传统 Edge 界面创建报告，请执行以下操作：

选择创收 >创收报告。
在下拉菜单中，选择要创建的报告类型。请参阅创收报告的类型。
点击 + 举报。
根据所选的结算类型配置报告详细信息，如以下部分所述： <ph type="x-smartling-placeholder">
- 配置结算报告
- 配置预付款余额报告
- 配置收入报告
- 配置差异报告（已弃用）
在报告窗口中输入信息后，您可以： <ph type="x-smartling-placeholder">
- 点击 Save as...（另存为...）可保存报告配置并在日后下载报告。
- 如果只想查看详细报告，请点击提交作业以异步方式运行报告并在稍后检索结果。有关详情，请参阅生成和下载报告。
- 点击 Download CSV（下载 CSV）以生成报告并将其下载到本地机器上，如下所示：逗号分隔值 (CSV) 文件进行查看。

配置结算报告

按照步骤配置报告，并在报告页面中输入以下信息：

字段	说明
结算月份	报告的结算月份。
汇报级别	报告级。有效值包括：明细：在单独的行中显示每笔交易，并且检查费率方案是否已正确应用。没有任何摘要。注意：CHARGE 交易不会包含在“详细信息”部分中因为这可能会涉及大量交易。摘要：汇总了各 API 产品的总收入以及开发者。注意：结算摘要不支持自定义属性报告。
商品套装	注意：在传统 Edge 界面中，API 产品捆绑包称为 API 软件包。选择要纳入到报告中的 API 产品组合。如果未选择任何选项，所有 API 产品套装都将包含在报告。对于每个选定的 API 产品套装，该报告都会单独列出一行。对于摘要报告，您可以选择在“摘要”显示选项中选中不显示。在本示例中汇总了所有（或选定）API 产品组合（并且未列出）的信息信息）。
产品	选择要纳入到报告中的 API 产品。如果未选择任何 API，所有 API 产品都会添加到报告。每个选定的 API 产品都会在报告中单独一行显示。对于摘要报告，您可以选择在“摘要”显示选项中选中不显示。在本示例中会汇总所有（或选定）开发者的信息（而不列出信息））。
公司	选择要纳入到报告中的公司。如果未选择任何公司，所有公司都会添加到报告。
价格方案	要包含在报告中的费率方案。选择以下某个选项：所有价格方案：在报告中包含所有价格方案。标准费率方案：仅在报告中包含标准费率方案。开发者专用费率方案：报告中仅包含开发者方案。

配置预付款余额报告

按照报告配置步骤操作，并在报告页面中输入以下信息：

字段

说明

结算月份

报告的结算月份。

汇报级别

报告级。有效值包括：

明细：单独显示每种余额补充，以便您与从付款处理方收到的付款进行对账。
摘要：总结每个补充剂的总剩余量开发者。

公司

选择要纳入到报告中的公司。如果未选择任何公司，所有公司都会添加到报告。

配置收入报告

按照步骤配置报告，并在报告页面中输入以下信息：

字段	说明
日期范围	报告的日期范围。选择以下某个选项：预设：选择一个标准日期范围（如“上一个日历” 月）。自定义：从以下日期范围中选择开始日期和结束日期：日历弹出式窗口。
选择币种	报告所用的货币。有效值包括：本地货币：报告的每一行都使用适用的费率方案显示。也就是说，如果开发者的方案使用不同的货币，则一份报告中可能会有多个货币。欧元：报告中的本地货币交易会换算为欧元，并显示为欧元。英镑：报告中的本地货币交易会换算为以英镑为单位。美元：报告中的本地货币交易会换算为美元。。注意：如果您选择具体币种，报告会显示所有交易以交易日期当天的现行汇率为准。
汇报级别	报告级。有效值包括：明细：在单独的行中显示每笔交易。还有无摘要。注意：CHARGE 交易不会包含在“详细信息”部分中因为这可能会涉及大量交易。摘要：汇总了各 API 产品的总收入以及开发者，具体取决于您选择的参数。
商品套装	注意：在传统 Edge 界面中，API 产品捆绑包称为 API 软件包。选择要纳入到报告中的 API 产品组合。如果未选择任何选项，所有 API 产品套装都将包含在报告。对于每个选定的 API 产品套装，该报告都会单独列出一行。对于摘要报告，您可以选择在“摘要”显示选项中选中不显示。在本示例中汇总了所有（或选定）API 产品组合（并且未列出）的信息信息）。
产品	选择要纳入到报告中的 API 产品。如果未选择任何 API，所有 API 产品都会添加到报告。每个选定的 API 产品都会在报告中单独一行显示。对于摘要报告，您可以选择在“摘要”显示选项中选中不显示。在本示例中会汇总所有（或选定）开发者的信息（而不列出信息））。
公司	选择要纳入到报告中的公司。如果未选择任何公司，所有公司都会添加到报告。对于摘要报告，您可以选择在摘要显示选项部分。在这种情况下，报告会汇总所有（或选定）公司的信息（不会单独列出每个选定公司的信息）。
应用	选择要使用的应用报告中包含的内容如果未选择任何内容，所有应用都将包含在报告。报告中会单独一行显示每个选定的应用。对于摘要报告，您可以选择在摘要显示选项部分。在这种情况下，该报告汇总了所有（或选定）应用程序（不会列出每个选定应用程序的信息））。
摘要显示选项	列在报告中的分组和显示顺序。选择一个号码指示该版块在分组中的相对顺序（1 表示第一个分组）。例如，以下代码会先按软件包对报告进行分组，然后再按然后是开发者，最后是应用如果您不希望显示某个部分，请选择不显示，然后按顺序选择其余字段更改订单的某个部分的相对顺序，或选择不在报告中显示某个部分。

在收入摘要报告中加入自定义交易属性

借助交易记录政策，您可以从交易中捕获自定义属性数据；以及就可以将这些自定义属性添加到摘要收入报告中定义默认的通过设置将自定义属性添加到获利数据库表贵组织的 MINT.SUMMARY_CUSTOM_ATTRIBUTES 属性。

使用该功能需要一些考虑和计划，因此请查看以下注意事项。

如果您是云客户，请联系 Apigee Edge 支持团队，属性。如果您是适用于私有云的 Apigee Edge 客户，请使用 PUT 请求设置标志使用系统管理员凭据访问以下 API。

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

在此示例中，API 调用会启用将 partner_id 和 tax_source 列添加到创收数据库。请注意，API 调用中的自定义属性数组为经过网址编码。

在报告中添加自定义交易属性的注意事项

在使用 API 创建属性名称之前，请先确定要使用的属性名称。这些是数据库中的列名称，自定义属性数据始终存储在其中。
每项交易记录政策中有 10 个可用的自定义属性位置，如下图所示为同一个关键字使用完全相同的属性名称和位置将会包含在报告中的所有产品的属性。例如，在以下交易记录政策、partner_id和tax_source自定义属性分别占据了方框 4 和 5。这应该是他们的名字和在所有包含在报告中的产品的交易记录政策。

要在启用此功能后将自定义属性添加到摘要收入报告中，请使用方法是将 transactionCustomAttributes 添加到 MintCriteria。请参阅条件配置选项。

配置差异报告（已弃用）

按照步骤配置报告，并在报告页面中输入以下信息：

字段	说明
日期范围	报告的日期范围。选择以下某个选项：预设：选择一个标准日期范围（如“上一个日历” 月）。自定义：从以下日期范围中选择开始日期和结束日期：日历弹出式窗口。
软件包	要包含在报告中的 API 软件包。选择以下某个选项：全部：包含报告中的所有 API 软件包。已选择：显示一个列表，您可以从中选择要添加的 API 软件包报告中包含的内容如果您未选择任何文件包，则所有文件包都会包含在报告。对于每个选定的 API 软件包，该报告都会单独列出一行。对于摘要报告，您可以选择在“摘要”中勾选“不显示（文件包）” 显示选项部分。在这种情况下，报告会汇总所有（或 API 软件包（不会列出每个 API 软件包的信息））。
产品	要包含在报告中的 API 产品。选择以下某个选项：全部：包含报告中的所有 API 产品。已选择：显示一个列表，您可以从中选择要包含的商品报告。如果您未选择任何商品，则所有商品都会包含在报告中。每个选定的 API 产品都会在报告中单独一行显示。对于摘要报告，您可以选择在“摘要”中勾选“不显示（商品）” 显示选项部分。在这种情况下，报告会汇总所有（或 API 产品（不会列出每个 API 产品的信息））。
公司	要包含在报告中的公司。选择以下某个选项：全部：包含报告中的所有公司。已选择：显示一个列表，您可以从中选择要包含的公司。如果您未选择任何公司，则所有公司都会添加到报告。每个选定的公司在报告中都会单独一行显示。对于摘要报告，您可以选择在摘要显示选项部分。在这种情况下，该报告汇总了所有（或选定的）公司（不会列出每个选定公司的信息））。
应用	要包含在报告中的应用。选择以下某个选项：全部：包含报告中的所有应用。已选择：显示一个列表，您可以从中选择要同步的应用报告中包含的内容如果您未选择任何应用，则所有应用都会包含在报告。报告中会单独一行显示每个选定的应用。对于摘要报告，您可以在摘要显示选项部分。在这种情况下，该报告汇总了所有（或选定）应用程序（不会列出每个选定应用程序的信息））。
货币	报告所用的货币。有效值包括：本地货币：报告的每一行都使用适用的费率方案显示。也就是说，如果开发者的方案使用不同的货币，则一份报告中可能会有多个货币。欧元：报告中的本地货币交易会换算为欧元，并显示为欧元。 GPB：报告中的本地货币交易会换算为以英镑为单位。美元：报告中的本地货币交易会进行换算并以美元显示。。注意：如果您选择 EUR、GBP 或 USD，报告就会显示全部使用单一货币进行的交易，具体取决于当天生效的汇率具体金额。
摘要显示选项	列在报告中的分组和显示顺序。选择一个号码指示该版块在分组中的相对顺序（1 表示第一个分组）。例如，以下代码会先按软件包对报告进行分组，然后再按然后是开发者，最后是应用如果您不希望显示某个部分，请选择不显示，然后按顺序选择其余字段更改订单的某个部分的相对顺序，或选择不在报告中显示某个部分。

生成并下载报告

创建报告后，您即可以 CSV 或 ZIP 文件格式下载报告结果。您可以同步或异步生成 CSV 或 ZIP 文件。

对于同步报告，您运行报告请求，并且在分析服务器提供响应之前，该请求会被阻止。但是，由于报告可能需要处理大量数据（例如 100 GB），同步报告可能会由于超时而失败。

摘要报表级别仅支持同步生成。
对于异步报告，您运行报告请求并在稍后检索结果。适合使用异步查询处理的情况包括：
- 分析和生成跨越很长时间间隔的报告。
- 使用各种分组维度以及增加查询复杂性的其他限制条件来分析数据
- 在发现某些用户或组织的数据量大幅增加时管理查询。
详细报告级别支持异步生成。

要生成和下载 CSV 或 zip 文件格式的报告，请执行以下任务之一：

访问“报告”页面。
将光标悬停在要下载的报告上。
在修改时间列下，点击以下任一选项：
1. 图标或图标（适用于摘要报告）。报告会同步保存到 CSV 或 ZIP 文件中。
2. 提交作业（针对详细报告）。异步作业启动。
  1. 在已修改列中监控作业的状态。
    
    当报告可供下载时，系统会显示磁盘图标：
  2. 该作业完成后，点击磁盘图标即可下载报告。

下面提供了一个摘要结算报告的 CSV 文件示例。

修改报告

要修改报告，请执行以下操作：

访问“报告”页面。
将光标悬停在要修改的报告上，然后点击操作菜单中的。
根据需要更新报告配置。
点击更新报告以保存更新后的报告配置。

删除报告

要删除报告，请执行以下操作：

访问“报告”页面。
将光标置于要删除的报告上。
点击操作菜单中的。

使用 API 管理创收报告

下面几部分将介绍如何使用该 API 管理创收报告。

使用 API 配置报告

要为整个组织配置报告，请将 POST 请求发送至 /organizations/{org_name}/report-definitions。

要为特定开发者配置报告，请向以下账号发出 POST 请求： /organizations/{org_name}/developers/{dev_id}/report-definitions，其中 {dev_id} 是开发者的身份识别信息。

在发出请求时，您需要指定报告的名称和类型。类型是以下各项之一：BILLING、REVENUE、VARIANCE（已弃用）或 PREPAID_BALANCE。此外，您可以在 mintCriteria 属性来进一步配置报告。有很多一个或多个条件这为配置报表提供了很大的灵活性。您可以指定为条件的内容包括：

对于结算或预付款余额报告，此字段是指报告的结算月份
对于收入报告，报告中包含的交易类型（例如购买）交易、收取交易款项和退款
对于预付款余额报告，该报告适用的开发者
对于收入报告报告适用
对于收入或差异报告，报告适用的币种
对于结算、预付余额或收入报告，报告是摘要报告还是详细报告
对于收入摘要报告，请在报告中添加自定义交易属性

如需查看完整的报告，请参阅报告配置选项报告条件。

例如，以下代码创建了一个收入报告，其中汇总了 2015 年 7 月该报告包含 transactionTypes 属性，并且仅适用于 Payment API 产品套装和 Payment API 产品。因为报告中未指定具体的开发者或应用定义，此报告适用于所有开发者和应用。由于 currencyOption 属性设置为 LOCAL，则报告的每一行都将显示均以适用费率方案的币种显示此外， groupBy 属性指定报告中的列按以下订单：PACKAGE、PRODUCT、DEVELOPER、APPLICATION 和 RATEPLAN（包括价格方案名称）和 ID）。

注意：报告fromDate和toDate的日期和时间现为 UTC/GMT，可以包含时间。

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

以下代码创建了一个详细的结算报告，其中显示开发者 DEV 的活动 5 表示 2015 年 6 月。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

使用 API 查看报告配置

您可以查看组织的特定报告配置或所有报告配置。您也可以查看单个开发者的报告配置

要查看某个组织的特定报告配置，请向以下地址发出 GET 请求： /organizations/{org_name}/report-definitions/{report_definition_id}，其中 {report_definition_id} 是特定报告配置（创建报告配置时，响应中会返回 ID）。例如：

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

要查看组织的所有报告配置，请向以下地址发出 GET 请求： /organizations/{org_name}/report-definitions。

您可以传递以下查询参数来对结果进行过滤和排序：

查询参数	说明
`all`	用于指定是否返回所有 API 商品套装的标志。如果设置为 false，则每页返回的 API 商品套装数量为由 `size` 查询参数定义。默认值为 false。
`size`	每页返回的 API 商品套装的数量。默认值为 20。如果 `all` 查询参数设置为 `true`，则系统会忽略此参数。
`page`	要返回的页面的编号（如果内容已分页）。如果 `all` 查询参数设置为 `true`，参数会被忽略。
`sort`	信息排序所依据的字段。如果 `all` 查询参数设置为 `true`，则系统会忽略此参数。默认值为 `UPDATED:DESC`。

例如，下面的请求会返回组织的报告配置，并限制检索到最多五种报告配置：

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

响应应类似如下所示（仅显示部分响应）：

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

如需查看特定开发者的报告配置，请向以下地址发出 GET 请求： /organizations/{org_name}/developers/{dev_id}/report-definitions，其中 {dev_id} 是开发者的身份识别信息。提出请求时，您可以指定上述查询参数来对数据进行过滤和排序。

例如，下面的请求会返回特定开发者的报告配置，并对回复（按报告名称）：

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

使用 API 更新报告配置

要更新报告配置，请向以下地址发出 PUT 请求： /organizations/{org_name}/report-definitions/{report_definition_id}，其中 {report_definition_id} 是特定报告配置的标识。时间则您需要在请求正文中指定更新后的配置值以及报告配置。例如，以下请求将报告更新为摘要报告（更新后的属性会突出显示）：

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

响应应类似如下所示（仅显示部分响应）：

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

使用 API 删除报告配置

要删除报告配置，请向以下对象发出 DELETE 请求： /organizations/{org_namer}/report-definitions/{report_definition_id}，其中 {report_definition_id} 是要删除的报告配置的标识。例如：

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

使用 API 生成报告

配置报告后，可以使用逗号分隔值生成报告 (CSV) 文件格式。

要生成报告，请将 POST 请求发送到 organizations/{org_id}/{report_type}，其中 {report_type} 指定要生成的报告类型类型包括：

billing-reports
revenue-reports
prepaid-balance-reports
variance-reports

此外，您还可以为特定开发者生成收入报告，具体说明请参见为开发者生成收入报告。

例如，要生成结算报告，可向 organizations/{org_name}/billing-reports。

在请求正文（任何类型的报告）中，指定报告的搜索条件。使用 mintCriteria 属性来指定搜索条件。有关详情，请参阅条件配置选项。

例如，以下请求基于各种条件搜索收入报告例如报告开始日期和结束日期以及交易类型。

注意：请报告 fromDate 和 toDate 日期以及时间采用 UTC/GMT 格式，可以包含时间。

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

找到后，系统会以 CSV 文件格式生成收入报告。以下代码提供了一个报告输出结果示例：

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

使用 API

如果自定义属性。在将开发者添加到如管理应用开发者中所述。

要在收入报告中添加自定义属性，请向 organizations/{org_name}/revenue-reports，并添加请求正文中的 devCustomAttributes 数组：

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

注意：请勿指定预定义的 MINT_* 和 devCustomAttributes 数组中的 ADMIN_* 属性。

例如，以下示例包含三个自定义属性：报告中的 BILLING_TYPE、SFID 和 ORG_EXT（如果已定义））：

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

下面提供了一个报告输出结果示例，其中包含两个自定义属性：

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

使用 API 报告交易活动

您可以向 /organizations/{org_name}/transaction-search。提出请求时，您需要指定检索条件。您可以指定为条件的内容包括：

已发出交易的一个或多个 API 产品的 ID。
交易的结算月份和年份。
发起交易的开发者。
交易类型，例如购买费和设置费。
交易状态，例如成功和失败。

如需查看完整的列表，请参阅条件配置选项条件。

例如，以下代码会返回由特定开发者针对结算进行的交易 2015 年 6 月：

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

您还可以确定哪些应用、开发者、API 产品捆绑包或 API 产品特定日期范围内的交易活动。您可以分别查看每个渠道的对象类型。例如，您可以查看具体关于访问您的获利 API 产品套装中的 API，以指定开始日期和结束日期。

要查看有关事务活动的信息，请向以下对象之一发出 GET 请求资源：

资源	返回
`/organizations/{org_name}/applications-with-transactions`	具有事务的应用
`/organizations/{org_name}/developers-with-transactions`	有交易的开发者
`/organizations/{org_name}/products-with-transactions`	与交易相关的商品
`/organizations/{org_name}/packages-with-transactions`	包含交易的 API 产品套装（或 API 套餐）

在发出请求时，您需要指定开始日期和结束日期作为查询参数。日期范围。例如，以下请求会返回具有事务的开发者获得的收入

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

响应应类似如下所示（仅显示部分响应）：

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

API 的报告配置选项

以下报告配置选项可供 API 使用：

名称	说明	默认	是否必需？
`name`	报告的名称。	不适用	是
`description`	报告的说明。	不适用	否
`mintCriteria`	用于配置报告的条件。请参阅标准配置选项了解详情。	不适用	否
`type`	报告的类型。可以是以下值之一： `BILLING` `REVENUE` `VARIANCE` `PREPAID_BALANCE`	不适用	是

条件配置选项

通过 mintCriteria 属性：

名称	说明	默认	是否必需？
`appCriteria`	要包含在报告中的特定应用的 ID 和组织。如果属性，则报告会涵盖所有应用。	不适用	否
`billingMonth`	注意：此属性不适用于收入报告。报告的结算月份，例如 JULY。	不适用	是
`billingYear`	注意：此属性不适用于收入报告。报告的结算年份，例如 2015。	不适用	是
`currCriteria`	要包含在报告中的特定货币的 ID 和组织。如果属性未指定任何值，则报告包含所有支持的货币。	不适用	否
`currencyOption`	报告所用的货币。有效值包括： `LOCAL`。报告的每一行都以适用的费率显示。也就是说，如果开发者有采用不同币种的方案。 `EUR`。本地货币交易以欧元。 `GPB`。本地货币交易会换算成以美元显示英镑。 `USD`。本地货币交易会换算成以美元显示国元。。注意：如果您选择 EUR、GBP 或 USD，报告就会显示全部使用单一货币进行的交易，具体取决于当天生效的汇率具体金额。	不适用	否
`devCriteria`	特定开发者的开发者 ID（电子邮件地址）和组织名称报告中包含的项目如果未指定此属性，则所有开发者都将包含在报告。例如： "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"my_org"} ]	不适用	否
`devCustomAttributes`	注意：此属性仅适用于收入报告。要包含在报告中的自定义属性（如果已针对开发者进行了定义）。对于示例： "devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ] 注意：请勿指定预定义的 `MINT_` 和 `devCustomAttributes` 数组中的 `ADMIN_` 属性。	不适用	否
`fromDate`	注意：此属性仅适用于收入、方差和交易活动报告。报告的开始日期（世界协调时间）。	不适用	收入报告必填；其他报告类型则不需要。
`groupBy`	报告中各列的分组顺序。有效值包括： `APPLICATION` `BALANCE` `DEVELOPER` `ORG` `PACKAGE` `PRODUCT` `RATEPLAN`	不适用	否
`monetizationPackageId`	要包含在报告中的一个或多个 API 产品集合的 ID。如果此属性不是则所有 API 产品组合都会包含在报告中。注意：在查看交易活动 (`/transaction-search`) 时，此属性无效。	不适用	否
`pkgCriteria`	要包含在报告中的特定 API 产品套装的 ID 和组织。如果属性，则报告将包含所有 API 产品套装。此媒体资源可以而不是 `monetizationpackageIds` 属性。注意：在查看交易活动 (`/transaction-search`) 时，此属性无效。	不适用	否
`prevFromDate`	注意：此属性仅适用于差异报告。上一个时间段的开始日期（世界协调时间 [UTC]）。用于为之前的以便与当前报告进行比较	不适用	否
`prevToDate`	注意：此属性仅适用于差异报告。上一个时间段的结束日期（世界协调时间 [UTC]）。用于创建上一时间段的报告以便与当前报告进行比较	不适用	否
`prodCriteria`	要包含在报告中的特定 API 产品的 ID 和组织。如果属性，则报告包含所有 API 产品。此媒体资源可以而不是 `productIds` 属性。注意：在查看交易活动 (`/transaction-search`) 时，此属性无效。	不适用	否
`productIds`	要包含在报告中的一个或多个 API 产品的 ID。如果此属性不是则所有 API 产品都会包含在该报告中。 API 产品 ID 应指定为 `org-name@@@product-name`。例如 `"productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]` 重要提示：仅就摘要报告而言，请排除产品 ID 的 `org-name@@@` 部分。例如： `"productIds": ["myproduct", "myproduct2"]`。否则，使用自定义属性因此不会显示在摘要报告中	不适用	否
`pricingTypes`	要包含在报告中的费率方案的定价类型。有效值包括： `REVSHARE`。收益分成方案。 `REVSHARE_RATECARD`。收益分成和价目表价目表。 `RATECARD`。价目表方案。如果未指定此属性，则所有定价类型的费率方案都会包含在报告。	不适用	否
`ratePlanLevels`	报告中要包含的价格方案的类型。有效值包括： `DEVELOPER`。开发者费率方案。 `STANDARD`。标准价格方案。如果未指定此属性，则开发者专用费率方案和标准费率方案均适用报告中包含的项目	不适用	否
`showRevSharePct`	指定报告是否显示收益分成比例的标志。有效值包括： `true`。显示收益分成比例。 `false`。不显示收益分成比例。	不适用	否
`showSummary`	此标记用于指定报告是否为摘要报告。有效值包括： `true`。报告为摘要。 `false`。报告不是摘要。	不适用	否
`showTxDetail`	注意：此属性仅适用于收入报告。用于指定报告是否显示交易级详细信息的标志。有效值包括： `true`。显示交易级详细信息。 `false`。不显示交易级详细信息。	不适用	否
`showTxType`	此标记用于指定报告是否显示每笔交易的类型。有效值包括： `true`。显示每笔交易的类型。 `false`。不显示每笔交易的类型。	不适用	否
`toDate`	注意：此属性仅适用于收入、方差和交易活动报告。报告的结束日期（世界协调时间）。该报告包含截至指定日期前一天结束所收集的数据。在指定结束日期收集的报告数据将被排除。例如，如果您想在 2016 年 12 月 31 日过期价格方案，则应将 toDate 值设置为 2017-01-01。在这种情况下，报告将包含截止到日期；2017 年 1 月 1 日的报告数据将被排除在外。	不适用	收入报告必填；其他报告类型则不需要。
`transactionStatus`	要包含在报告中的交易状态。有效值包括： `SUCCESS`。交易成功。 `DUPLICATE`。交易重复。可以忽略这些交易。来自 Apigee 的数据流水线运行时发送到评分服务器有时可能会生成重复的交易以便具有容错性，而创收功能会识别这些交易并将其标记为重复。 `FAILED`。交易失败。当前提条件验证失败时会触发此状态。例如： <ph type="x-smartling-placeholder"> </ph> 开发者尚未购买价格方案，已尝试评分。如果未配置创收限制检查政策，则可能会发生这种情况。已超出配额，但调用仍会继续。如果未配置创收限制检查政策，则可能会发生这种情况。为基于属性的自定义方案发送了否定自定义属性值。 `INVALID_TSC`。交易无效。当 `txProviderStatus` 运行时条件与 API 产品套装级别指定的成功条件不匹配时，就会触发此状态。 `REVIEW`。需要审核的交易。对于灵活收益分成费率方案，如果该值落在未配置的收入范围内，就会触发此状态。。注意：Apigee 创收不再返回 `FINAL` 状态。	不适用	否
`transactionCustomAttributes`	要添加到摘要收入报告中的自定义交易属性。您必须启用此功能。请参见添加自定义收入摘要报告中的交易属性。	不适用	否
`transactionTypes`	要包含在报告中的交易类型。有效值包括： `PURCHASE`：交易总数。仅适用于收益分成方案。 `CHARGE`：根据价目表费率方案计算的费用，用量报告期内的交易次数，从开发者购买价格方案之日算起。注意：用于计算 `CHARGE` 值的使用情况报告期与结算周期不同。 `REFUND`：退款已发放。请参阅退款。 `CREDIT`：已发放的赠金。请参阅发放赠金。 `BALANCE`：预付款账号的余额。请参阅管理预付款账号余额。 `SETUPFEES`：收取设置费用。请参阅为费率方案配置费用。 `TERMINATIONFEES`：收取的提前终止费用。请参阅为费率方案配置费用。 `RECURRINGFEES`：收取的周期性费用。请参阅使用 API 为费率方案配置费用和何时收取周期性费用以及何时重置套餐方案？。 `TRUEUP`：用于重新调整分级的交易交易。当上一次账单中的税费发生变化时，系统会调用这些函数。如果未指定此属性，则所有交易类型都会包含在报告。	不适用	否