本頁面由 Cloud Translation API 翻譯而成。

管理報表

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。資訊

簡介

營利報表可讓您查看重點的使用資訊和交易活動。舉例來說，您可以判斷在指定日期範圍內的交易活動。透過營利功能，您可以產生摘要或可追蹤 API 用量的詳細報表。

營利報表類型

您可以產生下列類型的營利報表。

檢舉	說明
帳單	查看單一帳單月份的開發人員活動，並確認適用費率已正確套用企劃書。
預付餘額	查看預付開發人員在某個帳單月份或方便您對帳付款處理方。
收益	查看開發人員在特定日期範圍內產生的活動和收益，即可分析 API 產品組合和產品對開發人員 (以及應用程式)。注意：收益報表包含截至月底收集到的資料一天的結束日期 (透過 `toDate` 設定選項指定)。凡是在指定結束日期收集到的報表資料，都不會從報表中排除。收益報表中的開發人員名稱是開發人員的法定名稱，你可以使用 `MINT_DEVELOPER_LEGAL_NAME` 自訂屬性設定開發人員法定名稱，詳情請參閱設定營利屬性。如果無法取得開發人員的法定名稱，Apigee 會將「開發人員名稱」設為開發人員名稱 (名字 + 姓氏)。假設未指定開發人員名稱；Apigee 會設定將「Developer Name」設為 `NA`。
變異	變化報表已淘汰，只能透過傳統版 Edge UI 設定。我們將在日後推出的版本中淘汰差異報表。比較開發人員在兩個日期範圍內產生的活動和收益，確保分析 API 套件與產品成效的上升或下降趨勢您的開發人員 (及他們的應用程式) 之間會不一致

關於資料保留

在 Apigee Edge 公有雲中，營利資料保留是一項方案授權。詳情請參閱營利資格：https://cloud.google.com/apigee/specsheets。如想保留營利資料的權限超過授權，請與 Apigee 銷售人員聯絡。系統會在提出要求時啟用延長資料保留功能，且無法用於納入早於原始資料保留期限的資料。

關於重複交易

比較營利交易報表與 Analytics 資料時重複交易的次數。這是正常現象，因為營利系統可以每日處理好幾百萬筆交易，而且任何交易都會同時處理在特定時刻平均而言，約有 0.1% 的交易可能重複。

探索「營利報表」頁面

存取「營利報表」頁面，方法如下：

邊緣

如何使用 Edge UI 存取「報表」頁面：

登入 apigee.com/edge。
選取「發布」>「發布」營利 >報表。

「報表」頁面隨即顯示。

如圖所示，您可以在「報表」頁面上執行下列操作：

查看所有報表的摘要資訊，包括名稱和說明、報表類型、日期範圍，以及上次修改日期
設定報表
產生並下載 CSV 或 ZIP 檔案格式的報表
編輯報表
刪除報表
搜尋報表清單

傳統版 Edge (Private Cloud)

如何使用傳統版 Edge UI 存取「報表」頁面：

登入「http://ms-ip:9000」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。
選取「營利」>上方導覽列中的營利報表。

「報表」頁面隨即顯示。

查看目前的報表清單
設定報表
產生並下載 CSV 格式的報表
編輯報表
刪除報表

設定報表

按照下列各節的說明，透過 UI 設定報表。

報表設定步驟

使用 Edge UI 或傳統版 Edge UI 設定報表。

Edge

如何使用 Edge UI 設定報表：

選取「發布」>「發布」營利 >報表。
按一下「+ 報表」。

設定下表中定義的報表詳細資料。

欄位	說明
名稱	報表的專屬名稱。
說明	報表的說明。
報告類型	請參閱營利報表類型。

根據所選的報表類型設定其他報表詳細資料，如下各節所述：
在報表視窗中輸入資訊後，您可以：
- 按一下「儲存報表」，即可儲存報表設定。
- 如需僅執行詳細報表，請按一下「提交工作」以非同步方式執行報表稍後再擷取結果。詳情請參閱產生及下載報表。
- 按一下「Save as CSV」或「Save as Zip」，將產生的報表以 ZIP 格式下載到您的本機電腦逗號分隔值 (CSV) 或包含 CSV 的壓縮 ZIP 檔案。下載 ZIP 檔案而且下載更有效率

傳統版 Edge (Private Cloud)

如何使用傳統版 Edge UI 建立報表：

選取「營利」>上方導覽列中的營利報表。
在下拉式選單中，選取要建立的報表類型。請參閱營利報表類型。
按一下「+ 報表」。
根據所選的帳單類型設定報表詳細資料，如以下各節所述：
- 設定帳單報表
- 設定預付餘額報表
- 設定收益報表
- 設定變異數報表 (已淘汰)
在報表視窗中輸入資訊後，您可以：
- 按一下「另存新檔...」來儲存報表設定，稍後再下載報表。
- 如需只有詳細報表，請按一下「提交工作」來密集執行報表稍後再擷取結果。詳情請參閱產生及下載報表。
- 按一下「下載 CSV」，即可產生報告並下載到本機電腦，格式為逗號分隔值 (CSV) 檔案即可查看。

設定帳單報表

請按照設定報表的步驟，在報表頁面中輸入下列資訊：

欄位	說明
帳單月份	報表的帳單月份。
報表層級	報表層級。有效值包括：詳細：逐行顯示每筆交易可讓你檢查費率方案是否已正確套用由於沒有摘要注意：「詳細」頁面不含 CHARGE 交易可能會產生大量交易摘要：列出每個 API 產品的總收益摘要，開發人員。注意：帳單摘要不支援自訂屬性報表。
產品組合	注意：在傳統版 Edge UI 中，API 產品套裝組合稱為 API 套件。選取要納入報表的 API 產品組合。如未選取，所有 API 產品組合都會納入報表。報表中的每個 API 產品組合會自成一行。如需摘要報表，您可以視需要勾選「摘要顯示」選項中的「不要顯示」。在這種情況下匯總所有 (或所選) API 產品組合 (且不會列出) 的資訊請參閱個別 API 產品套件的資訊)。
產品	選取要納入報表的 API 產品。如未選取，則所有 API 產品都會包含在報表。報表中的每項 API 產品會自成一行。如需摘要報表，您可以視需要勾選「摘要顯示」選項中的「不要顯示」。在這種情況下匯總所有 (或所選) 開發人員的資訊 (但不會列出 )。
公司	選取要納入報表的公司。如果未選取，所有公司都會加入報表。
費率方案	要納入報表的費率方案。請在下方選取一個適用選項：所有費率方案：在報表中納入所有費率方案。標準費率方案：只在報表中納入標準費率方案。開發人員專屬費率方案：在報表中僅列出開發人員方案。

設定預付餘額報表

請按照設定報表的步驟，在報表頁面中輸入下列資訊：

欄位

說明

帳單月份

報表的帳單月份。

報表層級

報表層級。有效值包括：

詳細：分別顯示每筆餘額補充，，與付款處理方收到的款項核對。
摘要：列出每個 Pod 的餘額為補充作業的摘要開發人員。

公司

選取要納入報表的公司。如果未選取，所有公司都會加入報表。

設定收益報表

請按照設定報表的步驟，在報表頁面中輸入下列資訊：

欄位	說明
日期範圍	報表的日期範圍。請在下方選取一個適用選項：預設：選取其中一個標準日期範圍 (例如上次日曆日期) 月份)。自訂：從日曆彈出式視窗。
選取貨幣	報表幣別。有效值包括：當地幣別：報表中的每一行都會以適用的費率方案顯示。也就是說，如果開發人員的方案使用不同的貨幣，則一份報表可能有多種貨幣。歐元：報表中的當地貨幣交易會以歐元顯示。英國英鎊：報表中的當地貨幣交易資料會以英鎊顯示。美元：報表中的當地幣別交易金額會以美元顯示。，瞭解如何調查及移除這項存取權。注意：如果選取特定貨幣，報表會顯示所有交易資料。根據交易日期生效的匯率，以單一貨幣計算費用。
報表層級	報表層級。有效值包括：詳細：分行顯示每筆交易。另有沒有摘要。注意：「詳細」頁面不含 CHARGE 交易可能會產生大量交易摘要：列出每個 API 產品的總收益摘要，視您選取的參數而定。
產品組合	注意：在傳統版 Edge UI 中，API 產品套裝組合稱為 API 套件。選取要納入報表的 API 產品組合。如未選取，所有 API 產品組合都會納入報表。報表中的每個 API 產品組合會自成一行。如需摘要報表，您可以視需要勾選「摘要顯示」選項中的「不要顯示」。在這種情況下匯總所有 (或所選) API 產品組合 (且不會列出) 的資訊請參閱個別 API 產品套件的資訊)。
產品	選取要納入報表的 API 產品。如未選取，則所有 API 產品都會包含在報表。報表中的每項 API 產品會自成一行。如需摘要報表，您可以視需要勾選「摘要顯示」選項中的「不要顯示」。在這種情況下匯總所有 (或所選) 開發人員的資訊 (但不會列出 )。
公司	選取要納入報表的公司。如果未選取，所有公司都會加入報表。如需摘要報表，您可以視需要勾選「不要顯示」摘要顯示選項區段。在這種情況下，報表會彙整所有 (或所選) 公司的資訊 (不會個別列出各家公司的資訊)。
應用程式	選取要匯入哪些應用程式加入報表如未選取，則所有應用程式都會位於即可。在這份報表中，每個所選應用程式都會自成一行。如需摘要報表，您可以視需要勾選「不要顯示」摘要顯示選項區段。在這種情況下，報表會彙整所有 (或已選取) 應用程式 (且未列出每個所選應用程式的資訊) 不同的應用程式)。
摘要顯示選項	在報表中分組並顯示資料欄的順序。請選取號碼，表示該區段在分組中的相對順序 (1 是第一個分組)。舉例來說，下列資料會先按照套件將報表分組，再按照開發人員和應用程式如果您不想顯示特定版面，請選取「不顯示」，然後依序選取其餘欄位這個訂單會在您變更其中一個區段的相對順序，或選擇不在報表中顯示某個區段。

在收益摘要報表中加入自訂交易屬性

交易記錄政策可讓你從交易中擷取自訂屬性資料，以及但可在摘要收益報表中加入這些自訂屬性定義預設一組自訂屬性貴機構的 MINT.SUMMARY_CUSTOM_ATTRIBUTES 屬性。

使用這項功能之前，請務必先審慎規劃及規劃，因此請詳閱下列注意事項。

如果您是雲端客戶，請與 Apigee Edge 支援團隊聯絡，將資源。如果您是適用於 Private Cloud 客戶的 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 加入報表 API MintCriteria。請參閱條件設定選項。

設定變異數報表 (已淘汰)

請按照設定報表的步驟，在報表頁面中輸入下列資訊：

欄位	說明
日期範圍	報表的日期範圍。請在下方選取一個適用選項：預設：選取其中一個標準日期範圍 (例如上次日曆日期) 月份)。自訂：從日曆彈出式視窗。
套件	要納入報表的 API 套件。請在下方選取一個適用選項：全部：包含報表中的所有 API 套件。已選取：顯示可供選擇的 API 套件清單加入報表如未選取，所有套件都會包含在報表。報表中會為每個 API 套件自成一行。針對摘要報表，您可以視需要勾選「摘要」中的「不顯示 (套裝)」「顯示選項」區段。在這種情況下，報表會彙整所有 (或已選取) API 套件 (不會列出每個 API 套件的資訊) )。
產品	要加進報表的 API 產品。請在下方選取一個適用選項：全部：包含報表中的所有 API 產品。已選取：顯示可選取要納入的產品清單即可。如果未選取任何產品，報表會納入所有產品。報表中的每項 API 產品會自成一行。如需摘要報表，您可以視需要勾選「摘要」中的「不顯示 (產品)」「顯示選項」區段。在這種情況下，報表會彙整所有 (或 (已選取) API 產品 (但不會列出每個 API 產品的資訊) )。
公司	要納入報表的公司。請在下方選取一個適用選項：全部：包含報表中的所有公司。已選取：顯示可選取要納入的公司清單顯示。如果您選取任何公司，那麼所有公司都會加入報表。在這份報表中，每家選擇的公司會自成一行。如需摘要報表，您可視需要勾選 [不要顯示 (公司)] 摘要顯示選項區段。在這種情況下，報表會彙整所有 (或已選取) 公司 (且未列出各選取公司的資訊) )。
應用程式	要納入報表的應用程式。請在下方選取一個適用選項：全部：包括報表中的所有應用程式。已選取：顯示可從哪些應用程式選取的應用程式加入報表如未選取任何應用程式，所有應用程式都會範圍即可。在這份報表中，每個所選應用程式都會自成一行。如需摘要報告，您可以視需要勾選「不要顯示 (應用程式)」的摘要顯示選項區段。在這種情況下，報表會彙整所有 (或已選取) 應用程式 (且未列出每個所選應用程式的資訊) 不同的應用程式)。
幣別	報表幣別。有效值包括：當地幣別：報表中的每一行都會以適用的費率方案顯示。也就是說，如果開發人員的方案使用不同的貨幣，則一份報表可能有多種貨幣。歐元：在報表中換算為當地貨幣的交易，並以歐元顯示。 GPB：報表中的當地貨幣交易資料會以英鎊顯示。美元：報表中的當地貨幣交易金額會以美元顯示。，瞭解如何調查及移除這項存取權。注意：如果您選取歐元、英鎊或美元，報表會顯示所有以該貨幣計算的交易，根據當日生效的匯率計算交易狀態
摘要顯示選項	在報表中分組並顯示資料欄的順序。請選取號碼，表示該區段在分組中的相對順序 (1 是第一個分組)。舉例來說，下列資料會先按照套件將報表分組，再按照開發人員和應用程式如果您不想顯示特定版面，請選取「不顯示」，然後依序選取其餘欄位這個訂單會在您變更其中一個區段的相對順序，或選擇不在報表中顯示某個區段。

產生及下載報表

建立報表後，您可以將報表結果下載為 CSV 或 ZIP 檔案格式。您可以選擇同步或非同步產生 CSV 或 ZIP 檔案。

若是同步報表，您執行報表要求，並封鎖請求直到分析伺服器提供回應但由於報表可能需要處理而同步報表可能會因逾時而失敗 (例如 100 GB 的 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 資源，可進一步設定報表。各式各樣的可指定的條件以便靈活設定報表。以下列舉幾個可以指定為條件的項目：

如果是帳單或預付餘額報表，則報表的帳單月份
收益報表：報表涵蓋的交易類型，例如「購買」交易、收取交易和退款
如果是預付餘額報表，報表適用對象為報表所屬的開發人員
收益報表：API 產品組合 (或 API 套件)、產品、費率方案和應用程式套用報表
收益或差異報表中顯示的幣別
針對帳單、預付餘額或收益報表，無論報表是摘要報表還是詳細報告
針對收益摘要報表，請在報表中加入自訂交易屬性

如需完整清單，請參閱「報表設定選項」一文報表條件。

舉例來說，下列指令會建立收益報表，當中列出交易活動的 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 的活動五月是 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 刪除報表設定

若要刪除報表設定，請向 /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

此外，您也可以為特定開發人員產生收益報表，詳情請見為開發人員產生收益報表。

舉例來說，如要產生帳單報表，請發出 POST 要求： organizations/{org_name}/billing-reports。

在要求主體 (適用於任何類型的報表) 中，為報表指定搜尋條件。使用 mintCriteria 屬性，用於指定搜尋條件。詳情請參閱條件設定選項。

舉例來說，下列要求會根據多項條件搜尋收益報表例如報表開始和結束日期，以及交易類型。

注意：回報 fromDate、toDate 的日期以及時間以世界標準時間/格林威治標準時間為準，可能包含時間。

$ 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 (應用程式介面)

就收益報表而言，假設為自訂屬性，您能夠在報表中加入自訂屬性屬性是針對開發人員定義而成。新增開發人員時，您可以定義自訂屬性請參閱「管理應用程式開發人員」一文。

如要在收益報表中加入自訂屬性，請發出 POST 要求： organizations/{org_name}/revenue-reports，並加入要求主體中的 devCustomAttributes 陣列：

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

注意：請勿指定預先定義的 MINT_* 和 devCustomAttributes 陣列中的 ADMIN_* 屬性。

舉例來說，以下範例包含 3 個自訂屬性報表中的 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。

如要查看交易活動的相關資訊，請向下列其中一個平台發出 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 套件)

發出請求時，您必須將開始日期和結束日期指定為查詢參數。日期範圍內舉例來說，下列要求會傳回有交易的開發人員於 2015 年 8 月

$ 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`	注意：這項資源不適用於收益報表。報表的帳單月份，例如 7 月。	不適用	是
`billingYear`	注意：這項資源不適用於收益報表。報表的帳單年份，例如 2015 年。	不適用	是
`currCriteria`	要納入報表的特定幣別 ID 和機構組織。如果這是資源，則所有受支援的貨幣都會納入報表。	不適用	否
`currencyOption`	報表幣別。有效值包括： `LOCAL`。報表的每一行都會以適用的費率顯示計畫。換句話說，如果開發人員在一份報表中，可能使用多種幣別有不同幣別的方案。 `EUR`。換算成當地貨幣的交易後，系統會以歐元。 `GPB`。換算成當地貨幣的交易時，系統會以英國顯示英鎊。 `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`	注意：這個屬性僅適用於變異數報表。上個經期的開始日期 (世界標準時間)。用來製作舊版比較期間。	不適用	否
`prevToDate`	注意：這個屬性僅適用於變異數報表。上個時段的結束日期 (世界標準時間)。用於製作上一段期間的報表以便與目前的報表進行比較	不適用	否
`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。在此情況下，報表將包含截至日期結束為止的報表資料為 2016 年 12 月 31 日2017 年 1 月 1 日的報表資料除外。	不適用	收益報表的必填項目；對其他報表類型的不需要。
`transactionStatus`	要納入報表的交易狀態。有效值包括： `SUCCESS`。交易成功。 `DUPLICATE`。重複的交易。您可以忽略這些交易。Apigee 的資料管道有時可能會產生重複交易，這是為了容錯，營利功能會將其視為重複項目。 `FAILED`。交易失敗。如果先決條件驗證失敗，就會觸發這個狀態。例如：嘗試評分的情況 (開發人員未購買費率方案)。如未設定營利限制檢查政策，就可能發生這種情況。超過配額，但呼叫仍會繼續。如未設定營利限制檢查政策，就可能發生這種情況。針對以屬性為準的自訂企劃書，已傳送排除自訂屬性值。 `INVALID_TSC`。交易無效。當 `txProviderStatus` 執行階段條件與 API 產品套件層級指定的成功條件不符時，就會觸發這個狀態。 `REVIEW`。需要審查的交易。如果彈性收益分潤費率方案的值落在未設定的收益範圍內，系統就會觸發這個狀態。，瞭解如何調查及移除這項存取權。注意：Apigee 營利功能不再傳回 `FINAL` 狀態。	不適用	否
`transactionCustomAttributes`	要加進摘要收益報表的自訂交易屬性。您必須啟用啟用此功能請參閱包括自訂的交易屬性	不適用	否
`transactionTypes`	要納入報表的交易類型。有效值包括： `PURCHASE`：交易總數。僅適用於收益分潤方案。 `CHARGE`：計費依據價目表費率方案和用量報表統計期內的交易次數，從開發人員購買費率方案的日期起算。注意：計算 `CHARGE` 值的用量報表統計期與帳單週期不同。 `REFUND`：已核發退款。請參閱退款後。 `CREDIT`：已核發的抵免額。請參閱核發抵免額一文。 `BALANCE`：預付帳戶的餘額。請參閱「管理預付帳戶餘額」。 `SETUPFEES`：設定收費費用。請參閱設定費率方案的費用。 `TERMINATIONFEES`：收取提前終止費用。請參閱設定費率方案的費用。 `RECURRINGFEES`：收取週期性費用。請參閱使用 API 設定費率方案的費用，以及系統何時會重新收取週期性費用和套裝組合方案？ `TRUEUP`：用於重新調整評分的交易交易在先前的帳單中發生稅務異動時，就會叫用這些欄位每月。如果未指定這個屬性，所有交易類型都會包含在報表。	不適用	否