Dengan menggunakan fitur Laporan Kustom Apigee, Anda dapat membuat laporan untuk melihat informasi monetisasi API Anda. Untuk membuat
laporan, Anda dapat menggunakan UI Apigee, stats API, atau queries API seperti
yang dijelaskan di bagian berikut:
Apigee menyediakan metrik dan dimensi monetisasi berikut:
Metrik dan dimensi untuk transaksi menggunakan proxy API
Metrik dan dimensi untuk transaksi berbasis biaya
Metrik dan dimensi untuk transaksi menggunakan proxy API
Tabel berikut mencantumkan metrik dan dimensi x_apigee_mintng_* yang tersedia untuk transaksi menggunakan proxy API:
Metrik
Nama di UI
Nama di API
Deskripsi
Pengganda harga API
x_apigee_mintng_price_multiplier
Faktor (pengali) yang digunakan untuk mengalikan biaya per transaksi.
Pembagian keuntungan developer
x_apigee_mintng_dev_share
Bagian developer dalam pendapatan transaksi.
Harga monetisasi
x_apigee_mintng_price
Total pendapatan transaksi.
Rasio monetisasi
x_apigee_mintng_rate
Tarif yang dibebankan untuk transaksi.
Dimensi
Nama di UI
Nama di API
Deskripsi
Mata uang pendapatan
x_apigee_mintng_currency
Mata uang pendapatan transaksi.
Keberhasilan transaksi
x_apigee_mintng_tx_success
Status monetisasi transaksi.
Metrik dan dimensi untuk transaksi berbasis biaya
Tabel berikut mencantumkan metrik dan dimensi yang hanya tersedia untuk
transaksi berbasis biaya:
Metrik
Nama di UI
Nama di API
Deskripsi
Biaya
biaya
Jumlah yang mewakili biaya penyiapan, biaya berulang, dan penambahan saldo prabayar.
Dimensi
Nama di UI
Nama di API
Deskripsi
Produk API
api_product
Produk API yang sesuai dengan paket tarif yang dikenai biaya penyiapan, biaya berulang,
atau biaya isi ulang prabayar. Nilai kosong untuk isi ulang prabayar.
Email Developer
developer_email
Developer akan ditagih biaya penyiapan, biaya berulang, atau pengisian ulang prabayar.
Jenis biaya
fees_type
Jenis biaya. Biaya ini dapat berupa biaya penyiapan, biaya berulang, atau isi ulang prabayar. Dimensi ini
akan menjadi null jika digunakan dengan metrik selain fees.
Akhir periode
period_end
Saat ini tersedia di organisasi Apigee, bukan organisasi Apigee Hybrid.
Akhir periode saat biaya berulang ditagih. Misalnya, untuk biaya bulanan,
ini adalah hari terakhir dalam sebulan.
Awal periode
period_start
Saat ini tersedia di organisasi Apigee, bukan organisasi Apigee Hybrid.
Awal periode saat biaya berulang ditagih. Misalnya, untuk biaya bulanan, ini adalah hari pertama dalam sebulan.
Mata uang pendapatan
x_apigee_mintng_currency
Mata uang biaya penyiapan, biaya berulang, atau penambahan saldo prabayar.
ID paket tarif
x_apigee_mintng_rate_plan_id
Saat ini tersedia di organisasi Apigee, bukan organisasi Apigee Hybrid.
Contoh laporan kustom berikut menampilkan jumlah Rasio monetisasi di semua aplikasi developer:
Untuk setiap aplikasi developer, sampel menampilkan total biaya semua transaksi dari 1-Apr-2021 to 15-Apr-2021. Biaya dihitung berdasarkan harga berbasis konsumsi sebagaimana dikonfigurasi dalam paket tarif Anda. Perhatikan bahwa dalam contoh ini,
metrik (x_apigee_mintng_rate) adalah kolom monetisasi, tetapi dimensi
(developer_app) adalah kolom non-monetisasi. Jadi, berdasarkan persyaratan Anda, Anda dapat membuat laporan dengan kombinasi kolom monetisasi dan non-monetisasi.
Anda juga dapat membatasi hasil berdasarkan karakteristik metrik dengan
menggunakan filter.
Untuk melihat biaya berulang pada laporan yang dibuat, sertakan dalam rentang tanggal yang dipilih hari setelah
hari terakhir bulan atau hari setelah tanggal habis masa berlaku langganan, karena biaya ditagih pada hari tersebut.
Mengekspor data analisis monetisasi
Di Apigee, Anda tidak perlu melakukan langkah tambahan apa pun untuk mengekspor data analisis monetisasi. Jika Anda
mengekspor data analisis, Apigee
mengekspor kolom monetisasi berikut bersama dengan data analisis reguler. Saat transaksi berbasis biaya dan transaksi yang menggunakan proxy API diekspor bersama, setiap data akan diekspor dengan metrik dan dimensi umum, dengan metrik dan dimensi lainnya (yang tidak terkait) ditetapkan ke NULL.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-04 UTC."],[[["\u003cp\u003eThis documentation outlines how to use Apigee's Custom Reports feature to view monetization data for APIs, applicable to both Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eYou can generate monetization reports through the Apigee UI, the Stats API, or the Queries API, utilizing monetization-specific metrics and dimensions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ex_apigee_mintng_*\u003c/code\u003e metrics and dimensions track API proxy transaction details, such as price multipliers, developer share, and transaction success, while also being able to combine with other non-monetization related fields.\u003c/p\u003e\n"],["\u003cp\u003eFee-based transactions have their own set of metrics (like \u003ccode\u003efees\u003c/code\u003e) and dimensions (like \u003ccode\u003eapi_product\u003c/code\u003e and \u003ccode\u003efees_type\u003c/code\u003e) that capture setup, recurring, and prepaid fees.\u003c/p\u003e\n"],["\u003cp\u003eWhen exporting analytics data, Apigee includes monetization fields alongside regular data, such as \u003ccode\u003ex_apigee_mintng_price\u003c/code\u003e, \u003ccode\u003ex_apigee_mintng_rate\u003c/code\u003e, and \u003ccode\u003eperiod_start\u003c/code\u003e, and common metrics and dimensions, with non-related fields set to NULL.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n| Note: Generating Custom Reports is not supported in Apigee hybrid. [Known issue: 355714868](/apigee/docs/release/known-issues#355714868)\n\nBy using Apigee's [Custom Reports](/apigee/docs/api-platform/analytics/create-custom-reports)\nfeature, you can generate reports to view monetization information of your APIs. To generate\nthe reports, you can use the Apigee UI, the stats API, or the queries API as\ndescribed in the following sections:\n\n- [Adding a custom report using the Apigee UI](/apigee/docs/api-platform/analytics/create-custom-reports#add)\n- [Stats API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.stats/get)\n- [Queries API (Asynchronous custom reports API)](/apigee/docs/api-platform/analytics/asynch-reports-api)\n\nMonetization metrics and dimensions\n\nApigee provides the following monetization metrics and dimensions:\n\n\n- Metrics and dimensions for transactions using an API proxy\n- Metrics and dimensions for fee-based transactions\n\nMetrics and dimensions for transactions using an API proxy\n\nThe following tables list the `x_apigee_mintng_*` metrics and dimensions available for\ntransactions using an API proxy:\n\n- **Metrics**\n\n | Name in UI | Name in API | Description |\n |----------------------------|----------------------------------|--------------------------------------------------------------------------|\n | Api price multiplier | x_apigee_mintng_price_multiplier | The factor (multiplier) by which the per-transaction cost is multiplied. |\n | Developer share of revenue | x_apigee_mintng_dev_share | Developer's share in a transaction's revenue. |\n | Monetization price | x_apigee_mintng_price | Total revenue of a transaction. |\n | Monetization rates | x_apigee_mintng_rate | Rate charged for a transaction. |\n\n- **Dimensions**\n\n | Name in UI | Name in API | Description |\n |---------------------|----------------------------|-----------------------------------------|\n | Revenue currency | x_apigee_mintng_currency | Currency of the transaction revenue. |\n | Transaction success | x_apigee_mintng_tx_success | Monetization status of the transaction. |\n\n| **Note:**\n|\n| - For the transactions using an API proxy, you can also use [other metrics and dimensions](/apigee/docs/api-platform/analytics/analytics-reference) along with the `x_apigee_mintng_*` metrics and dimensions.\n| - The interpretation of a dimension value depends on the metric. For example, if you select the `API Product` dimension, for a fee-based transaction, the value will be the name of the API product corresponding to the rate plan for which setup fee or recurring fee should be applied. However, if you select the `API Product` dimension for a non-fee-based transaction, the value will be the name of the API product containing the API proxies being called.\n\nMetrics and dimensions for fee-based transactions\n\nThe following tables list the metrics and dimensions available only for\nfee-based transactions:\n\n- **Metrics**\n\n | Name in UI | Name in API | Description |\n |------------|-------------|-----------------------------------------------------------------------|\n | Fees | fees | Amount representing the setup fee, recurring fees, and prepaid topup. |\n\n- **Dimensions**\n\n | Name in UI | Name in API | Description |\n |------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | API Product | api_product | API product corresponding to the rate plan for which the setup fee, recurring fee, or prepaid topup fee applies. The value is empty for a prepaid topup. |\n | Developer Email | developer_email | Developer to be charged with the setup fee, recurring fees, or prepaid topup. |\n | Fees type | fees_type | Type of fee. It can be a setup fee, recurring fee, or prepaid topup. This dimension will be `null` when used with any metric other than the `fees`. |\n | Period end | period_end | Currently available in Apigee orgs, not Apigee hybrid orgs. End of the period for which recurring fees are charged. For example, for a monthly fee this is the last day of the month. |\n | Period start | period_start | Currently available in Apigee orgs, not Apigee hybrid orgs. Start of the period for which recurring fees are charged. For example, for a monthly fee this is the first day of the month. |\n | Revenue currency | x_apigee_mintng_currency | Currency of the setup fee, recurring fee, or prepaid topup. |\n | Rate plan ID | x_apigee_mintng_rate_plan_id | Currently available in Apigee orgs, not Apigee hybrid orgs. The monetization rate plan for the app developer. |\n\n\nFor detailed descriptions of these metrics and dimensions, see\n[Analytics metrics, dimensions, and filters reference](/apigee/docs/api-platform/analytics/analytics-reference).\n\n\nThe following sample custom report displays the **sum of Monetization rates** across all the developer apps:\n\n\nFor each developer app, the sample, shows the total cost of all the transactions from `1-Apr-2021 to 15-Apr-2021`. The\ncost is calculated based on the consumption-based pricing as configured in your rate plan. Notice that in this example,\nthe metric (`x_apigee_mintng_rate`) is a monetization field but the dimension\n(`developer_app`) is a non-monetization field. So, based on your\nrequirements, you can generate reports with a combination of both monetization and non-monetization fields.\n\nYou can also limit your results based on metric characteristics by\nusing [filters](/apigee/docs/api-platform/analytics/analytics-reference#filters).\n\nTo see recurring fees on generated reports, include in the selected date range the day after the\nlast day of the month or the day after the subscription expiration date, as this is when they are charged.\n\nExporting monetization analytics data In Apigee you do not need to perform any additional steps to export your monetization analytics data. If you are [exporting analytics data](/apigee/docs/api-platform/analytics/export-data), Apigee exports the following monetization fields along with regular analytics data. When fee-based transactions and transactions using an API proxy are exported together, each record exports with the common metrics and dimensions, with other (non-related) metrics and dimensions set to NULL. Note: See the exporting page linked in the previous sentence for additional information on these values.\n\n- `client_received_start_timestamp`\n- `period_end`\n- `period_start`\n- `x_apigee_mintng_currency`\n- `x_apigee_mintng_dev_share`\n- `x_apigee_mintng_price`\n- `x_apigee_mintng_price_multiplier`\n- `x_apigee_mintng_rate`\n- `x_apigee_mintng_rate_plan_id`\n- `x_apigee_mintng_tx_success`"]]
