Mediante la función Informes personalizados de Apigee, puedes generar informes para ver la información de monetización de tus API. Para generar los informes, puedes usar la IU de Apigee, la API de estadísticas o la API de consultas, como se describe en las siguientes secciones:
Apigee proporciona las siguientes métricas y dimensiones de monetización:
Métricas y dimensiones para transacciones con un proxy de API
Métricas y dimensiones para transacciones basadas en tarifas
Métricas y dimensiones para transacciones con un proxy de API
En las siguientes tablas, se enumeran las métricas y las dimensiones x_apigee_mintng_* disponibles para las transacciones que usan un proxy de API:
Métricas
Nombre en la IU
Nombre en la API
Descripción
Multiplicador de precios de la API
x_apigee_mintng_price_multiplier
El factor (multiplicador) por el que se multiplica el costo por transacción.
Porcentaje de ingresos del desarrollador
x_apigee_mintng_dev_share
Porcentaje del desarrollador en los ingresos de una transacción.
Precio de la monetización
x_apigee_mintng_price
Los ingresos totales de una transacción.
Tasas de monetización
x_apigee_mintng_rate
Tarifa cobrada por una transacción.
Dimensiones
Nombre en la IU
Nombre en la API
Descripción
Moneda de los ingresos
x_apigee_mintng_currency
Moneda de los ingresos de la transacción.
Éxito de la transacción
x_apigee_mintng_tx_success
Estado de monetización de la transacción.
Métricas y dimensiones para transacciones basadas en tarifas
En las siguientes tablas, se enumeran las métricas y las dimensiones disponibles únicamente para transacciones basadas en tarifas:
Métricas
Nombre en la IU
Nombre en la API
Descripción
Tarifas
tarifas
El importe que representa la tarifa de configuración, las tarifas recurrentes y las recargas de prepago.
Dimensiones
Nombre en la IU
Nombre en la API
Descripción
Producto de API
api_product
Producto de API correspondiente al plan de tarifas al que se aplica la tarifa de configuración, la tarifa recurrente o la recarga de prepago. El valor está vacío para una recarga de prepago.
Correo electrónico del desarrollador
developer_email
Se le cobrará al desarrollador la tarifa de configuración, las tarifas recurrentes o la recarga de prepago.
Tipo de tarifa
fees_type
Tipo de tarifa. Puede ser una tarifa de configuración, una tarifa recurrente o una recarga de prepago. Esta dimensión será null cuando se use con cualquier métrica que no sea fees.
Final del período
period_end
Actualmente, está disponible en organizaciones de Apigee, no en organizaciones híbridas de Apigee.
Fin del período por el que se cobran las tarifas recurrentes. Por ejemplo, para una tarifa mensual, este es el último día del mes.
Inicio del período
period_start
Actualmente, está disponible en organizaciones de Apigee, no en organizaciones híbridas de Apigee.
Inicio del período por el que se cobran las tarifas recurrentes. Por ejemplo, por una tarifa mensual, este es el primer día del mes.
Moneda de los ingresos
x_apigee_mintng_currency
La moneda de la tarifa de configuración, tarifa recurrente o cuota prepaga.
ID de plan de tarifa
x_apigee_mintng_rate_plan_id
Actualmente, está disponible en organizaciones de Apigee, no en organizaciones híbridas de Apigee.
El plan de tasa de monetización del desarrollador de apps.
El siguiente informe personalizado de muestra demuestra la suma de las tarifas de monetización en todas las apps para desarrolladores:
Para cada app de desarrollador, en la muestra aparece el costo total de todas las transacciones de 1-Apr-2021 to 15-Apr-2021. El costo se calcula en función de los precios por consumo como se configuró en tu plan de tarifas. Ten en cuenta que, en este ejemplo, la métrica (x_apigee_mintng_rate) es un campo de monetización, pero la dimensión (developer_app) no es un campo de monetización. Por lo tanto, según tus requisitos, puedes generar informes con una combinación de campos de monetización y de no monetización.
También puedes limitar los resultados según las características de la métrica mediante filtros.
Exporta datos de estadísticas de monetización
En Apigee, no necesitas realizar ningún paso adicional para exportar los datos de estadísticas de monetización. Si exportas datos de estadísticas, Apigee exporta los siguientes campos de monetización junto con datos de estadísticas normales. Cuando las transacciones basadas en tarifas y transacciones que usan un proxy de API se exportan juntas, cada registro exporta con las métricas y dimensiones comunes, con otras métricas (no relacionadas) y las dimensiones establecidas en NULL.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-08 (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`"]]
