By using Apigee'sCustom Reportsfeature, you can generate reports to view monetization information of your APIs. To generate
the reports, you can use the Apigee UI, the stats API, or the queries API as
described in the following sections:
Apigee provides the following monetization metrics and dimensions:
Metrics and dimensions for transactions using an API proxy
Metrics and dimensions for fee-based transactions
Metrics and dimensions for transactions using an API proxy
The following tables list thex_apigee_mintng_*metrics and dimensions available for
transactions using an API proxy:
Metrics
Name in UI
Name in API
Description
Api price multiplier
x_apigee_mintng_price_multiplier
The factor (multiplier) by which the per-transaction cost is multiplied.
Developer share of revenue
x_apigee_mintng_dev_share
Developer's share in a transaction's revenue.
Monetization price
x_apigee_mintng_price
Total revenue of a transaction.
Monetization rates
x_apigee_mintng_rate
Rate charged for a transaction.
Dimensions
Name in UI
Name in API
Description
Revenue currency
x_apigee_mintng_currency
Currency of the transaction revenue.
Transaction success
x_apigee_mintng_tx_success
Monetization status of the transaction.
Metrics and dimensions for fee-based transactions
The following tables list the metrics and dimensions available only for
fee-based transactions:
Metrics
Name in UI
Name in API
Description
Fees
fees
Amount representing the setup fee, recurring fees, and prepaid topup.
Dimensions
Name in UI
Name in API
Description
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.
Developer Email
developer_email
Developer to be charged with the setup fee, recurring fees, or prepaid topup.
Fees type
fees_type
Type of fee. It can be a setup fee, recurring fee, or prepaid topup. This dimension
will benullwhen used with any metric other than thefees.
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.
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.
Revenue currency
x_apigee_mintng_currency
Currency of the setup fee, recurring fee, or prepaid topup.
Rate plan ID
x_apigee_mintng_rate_plan_id
Currently available in Apigee orgs, not Apigee hybrid orgs.
The following sample custom report displays thesum of Monetization ratesacross all the developer apps:
For each developer app, the sample, shows the total cost of all the transactions from1-Apr-2021 to 15-Apr-2021. The
cost is calculated based on the consumption-based pricing as configured in your rate plan. Notice that in this example,
the metric (x_apigee_mintng_rate) is a monetization field but the dimension
(developer_app) is a non-monetization field. So, based on your
requirements, you can generate reports with a combination of both monetization and non-monetization fields.
You can also limit your results based on metric characteristics by
usingfilters.
To see recurring fees on generated reports, include in the selected date range the day after the
last day of the month or the day after the subscription expiration date, as this is when they are charged.
Exporting monetization analytics data
In Apigee you do not need to perform any additional steps to export your monetization analytics
data. If you areexporting analytics 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 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,["# Generating monetization reports\n\n*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-----------------------------------\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\n### Metrics 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- **Dimensions**\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\n### Metrics 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- **Dimensions**\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\n-------------------------------------\n\nIn 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`"]]
