Mithilfe des Apigee-Features Benutzerdefinierte Berichte können Sie Berichte generieren, um Monetarisierungsinformationen Ihrer APIs anzuzeigen. Zum Generieren der Berichte können Sie die Apigee-Benutzeroberfläche, die Stats API oder die Queries API verwenden, wie in den folgenden Abschnitten beschrieben:
Apigee bietet die folgenden Monetarisierungsmesswerte und -dimensionen:
Messwerte und Dimensionen für Transaktionen mit einem API-Proxy
Messwerte und Dimensionen für gebührenbasierte Transaktionen
Messwerte und Dimensionen für Transaktionen mit einem API-Proxy
In den folgenden Tabellen sind die x_apigee_mintng_*-Messwerte und -Dimensionen aufgeführt, die für Transaktionen mit einem API-Proxy verfügbar sind:
Messwerte
Name in der Benutzeroberfläche
Name in der API
Beschreibung
API-Preismultiplikator
x_apigee_mintng_price_multiplier
Der Faktor (Multiplikator), mit dem die Kosten pro Transaktion multipliziert werden.
Umsatzanteil des Entwicklers
x_apigee_mintng_dev_share
Anteil des Entwicklers am Umsatz einer Transaktion.
Monetarisierungspreis
x_apigee_mintng_price
Gesamtumsatz einer Transaktion.
Monetarisierungsraten
x_apigee_mintng_rate
Preis für eine Transaktion.
Dimensionen
Name in der Benutzeroberfläche
Name in der API
Beschreibung
Währung des Umsatzes
x_apigee_mintng_currency
Währung des Transaktionsumsatzes.
Transaktionserfolg
x_apigee_mintng_tx_success
Monetarisierungsstatus der Transaktion.
Messwerte und Dimensionen für gebührenbasierte Transaktionen
In den folgenden Tabellen sind die Messwerte und Dimensionen aufgeführt, die nur für gebührenbasierte Transaktionen verfügbar sind:
Messwerte
Name in der Benutzeroberfläche
Name in der API
Beschreibung
Gebühren
Lizenzgebühren
Betrag, der für die Einrichtungsgebühr, wiederkehrende Gebühren und die Vorauszahlungen steht.
Dimensionen
Name in der Benutzeroberfläche
Name in der API
Beschreibung
API-Produkt
API-Produkt
API-Produkt, das dem Tarif entspricht, für den die Einrichtungsgebühr, die wiederkehrende Gebühr oder die Vorauszahlungsgebühr gilt. Bei einer Vorauszahlung ist der Wert leer.
E-Mail-Adresse des Entwicklers
developer_email
Dem Entwickler werden die Einrichtungsgebühr, wiederkehrende Gebühren oder eine Vorauszahlung berechnet.
Gebührentyp
fees_type
Art der Gebühr. Dabei kann es sich um eine Einrichtungsgebühr, eine wiederkehrende Gebühr oder eine Vorauszahlung handeln. Diese Dimension ist null, wenn sie mit einem anderen Messwert als fees verwendet wird.
Ende des Zeitraums
period_end
Derzeit in Apigee-Organisationen verfügbar, nicht in Apigee Hybrid-Organisationen.
Ende des Zeitraums, für den wiederkehrende Gebühren berechnet werden. Bei einer monatlichen Gebühr ist dies beispielsweise der letzte Tag im Monat.
Beginn des Zeitraums
period_start
Derzeit in Apigee-Organisationen verfügbar, nicht in Apigee Hybrid-Organisationen.
Beginn des Zeitraums, für den wiederkehrende Gebühren berechnet werden. Bei einer monatlichen Gebühr ist dies beispielsweise der erste Tag im Monat.
Währung des Umsatzes
x_apigee_mintng_currency
Währung der Einrichtungsgebühr, wiederkehrenden Gebühr oder Vorauszahlung.
Tarifpaket-ID
x_apigee_mintng_rate_plan_id
Derzeit in Apigee-Organisationen verfügbar, nicht in Apigee Hybrid-Organisationen.
Der Monetarisierungstarif für den Anwendungsentwickler.
Der folgende benutzerdefinierte Beispielbericht zeigt die Summe der Monetarisierungsraten in allen Entwickleranwendungen:
Im Beispiel werden für jede Entwickleranwendung die Gesamtkosten aller Transaktionen aus 1-Apr-2021 to 15-Apr-2021 angezeigt. Die Kosten werden basierend auf den nutzungsbasierten Preisen berechnet, wie in Ihrem Tarif konfiguriert. Beachten Sie, dass der Messwert (x_apigee_mintng_rate) in diesem Beispiel ein Monetarisierungsfeld ist, die Dimension (developer_app) jedoch ein Nicht-Monetarisierungsfeld. Je nach Ihren Anforderungen können Sie also Berichte mit einer Kombination aus Monetarisierungs- und Nicht-Monetarisierungsfeldern erstellen.
Sie können Ihre Ergebnisse auch anhand von Messwerteigenschaften einschränken, indem Sie Filter verwenden.
Wenn Sie wiederkehrende Gebühren in generierten Berichten sehen möchten, müssen Sie im ausgewählten Zeitraum den Tag nach dem letzten Tag des Monats oder den Tag nach dem Ablaufdatum des Abos angeben, da die Gebühren dann berechnet werden.
Analysedaten für die Monetarisierung exportieren
In Apigee müssen Sie keine zusätzlichen Schritte ausführen, um Ihre Monetarisierungsanalysedaten zu exportieren. Wenn Sie Analysedaten exportieren, exportiert Apigee die folgenden Monetarisierungsfelder sowie reguläre Analysedaten. Wenn gebührenbasierte Transaktionen und Transaktionen mithilfe eines API-Proxys zusammen exportiert werden, wird jeder Datensatz mit den gemeinsamen Messwerten und Dimensionen exportiert, wobei andere (nicht verwandte) Messwerte und Dimensionen auf NULL gesetzt sind.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 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`"]]
