Con la función Informes personalizados
de Apigee, puedes generar informes para ver la información de monetización de tus APIs. Para generar los informes, puede usar la interfaz de usuario de Apigee, la API de estadísticas o la API de consultas, tal como se describe en las siguientes secciones:
Apigee proporciona las siguientes métricas y dimensiones de monetización:
Métricas y dimensiones de las transacciones que usan un proxy de API
Métricas y dimensiones de las transacciones basadas en comisiones
Métricas y dimensiones de las transacciones que usan un proxy de API
En las siguientes tablas se indican las métricas y dimensiones de x_apigee_mintng_* disponibles para las transacciones que usan un proxy de API:
Métricas
Nombre en la interfaz de usuario
Nombre en la API
Descripción
Multiplicador de precios de la API
x_apigee_mintng_price_multiplier
Factor (multiplicador) por el que se multiplica el coste por transacción.
Reparto de ingresos del desarrollador
x_apigee_mintng_dev_share
Parte del desarrollador en los ingresos de una transacción.
Precio de monetización
x_apigee_mintng_price
Ingresos totales de una transacción.
Tarifas de monetización
x_apigee_mintng_rate
Tarifa cobrada por una transacción.
Dimensiones
Nombre en la interfaz de usuario
Nombre en la API
Descripción
Moneda de ingresos
x_apigee_mintng_currency
Moneda de los ingresos de la transacción.
Transacción correcta
x_apigee_mintng_tx_success
Estado de monetización de la transacción.
Métricas y dimensiones de las transacciones basadas en comisiones
En las siguientes tablas se enumeran las métricas y dimensiones disponibles solo para las transacciones de pago:
Métricas
Nombre en la interfaz de usuario
Nombre en la API
Descripción
Tarifas
de Postini
Importe que representa la cuota de configuración, las cuotas periódicas y la recarga prepago.
Dimensiones
Nombre en la interfaz de usuario
Nombre en la API
Descripción
Producto de API
api_product
Producto de API correspondiente al plan de tarifas al que se aplica la cuota de configuración, la cuota periódica o la cuota de recarga prepago. El valor está vacío en el caso de las recargas prepago.
Correo electrónico del desarrollador
developer_email
Se cobrará al Desarrollador la cuota de configuración, las cuotas periódicas o la recarga prepago.
Tipo de tarifa
fees_type
Tipo de tarifa. Puede ser una cuota de configuración, una cuota periódica o una recarga prepago. Esta dimensión será null cuando se use con cualquier métrica que no sea fees.
Final del periodo
period_end
Actualmente disponible en organizaciones de Apigee, no en organizaciones de Apigee hybrid.
Fin del periodo durante el que se cobran las cuotas periódicas. Por ejemplo, en el caso de una cuota mensual, se trata del último día del mes.
Inicio del periodo
period_start
Actualmente disponible en organizaciones de Apigee, no en organizaciones de Apigee hybrid.
Inicio del periodo durante el que se cobran las cuotas periódicas. Por ejemplo, en el caso de una cuota mensual, se trata del primer día del mes.
Moneda de ingresos
x_apigee_mintng_currency
Moneda de la cuota de configuración, la cuota periódica o la recarga prepago.
ID del plan de tarifas
x_apigee_mintng_rate_plan_id
Actualmente disponible en organizaciones de Apigee, no en organizaciones de Apigee hybrid.
El plan de tarifas de monetización del desarrollador de la aplicación.
El siguiente informe personalizado de ejemplo muestra la suma de las tasas de monetización de todas las aplicaciones del desarrollador:
En cada aplicación de desarrollador, la muestra muestra el coste total de todas las transacciones de 1-Apr-2021 to 15-Apr-2021. El coste se calcula en función de los precios basados en el consumo configurados en tu plan de tarifas. En este ejemplo, la métrica (x_apigee_mintng_rate) es un campo de monetización, pero la dimensión (developer_app) no lo es. Por lo tanto, en función de tus requisitos, puedes generar informes con una combinación de campos de monetización y no monetización.
También puede limitar los resultados en función de las características de las métricas mediante filtros.
Para ver las comisiones periódicas en los informes generados, incluya en el periodo seleccionado el día posterior al último día del mes o el día posterior a la fecha de vencimiento de la suscripción, ya que es cuando se cobran.
Exportar datos de analíticas de monetización
En Apigee, no es necesario que realice ningún paso adicional para exportar sus datos de analíticas de monetización. Si exporta datos analíticos, Apigee exporta los siguientes campos de monetización junto con los datos analíticos habituales. Cuando se exportan juntas transacciones basadas en comisiones y transacciones que usan un proxy de API, cada registro se exporta con las métricas y dimensiones comunes, mientras que otras métricas y dimensiones (no relacionadas) se definen como NULL.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información 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`"]]
