Utilizzando la funzionalità Report personalizzati di Apigee, puoi generare report per visualizzare le informazioni sulla monetizzazione delle tue API. Per generare
i report, puoi utilizzare la UI di Apigee, l'API Stats o l'API Queries come
descritto nelle sezioni seguenti:
Apigee fornisce le seguenti metriche e dimensioni di monetizzazione:
Metriche e dimensioni per le transazioni che utilizzano un proxy API
Metriche e dimensioni per le transazioni a pagamento
Metriche e dimensioni per le transazioni che utilizzano un proxy API
Le tabelle seguenti elencano le metriche e le dimensioni x_apigee_mintng_* disponibili per le transazioni che utilizzano un proxy API:
Metriche
Nome nell'interfaccia utente
Nome nell'API
Descrizione
Moltiplicatore del prezzo dell'API
x_apigee_mintng_price_multiplier
Il fattore (moltiplicatore) per cui viene moltiplicato il costo per transazione.
Quota di condivisione delle entrate dello sviluppatore
x_apigee_mintng_dev_share
Quota dello sviluppatore nelle entrate di una transazione.
Prezzo della monetizzazione
x_apigee_mintng_price
Entrate totali di una transazione.
Tassi di monetizzazione
x_apigee_mintng_rate
Tasso addebitato per una transazione.
Dimensioni
Nome nell'interfaccia utente
Nome nell'API
Descrizione
Valuta delle entrate
x_apigee_mintng_currency
Valuta delle entrate da transazioni.
Transazione eseguita
x_apigee_mintng_tx_success
Stato della monetizzazione della transazione.
Metriche e dimensioni per le transazioni a pagamento
Le tabelle seguenti elencano le metriche e le dimensioni disponibili solo per le transazioni a pagamento:
Metriche
Nome nell'interfaccia utente
Nome nell'API
Descrizione
Tariffe
tariffe
Importo che rappresenta la tariffa di configurazione, le tariffe ricorrenti e la ricarica prepagata.
Dimensioni
Nome nell'interfaccia utente
Nome nell'API
Descrizione
Prodotto API
api_product
Prodotto API corrispondente al piano tariffario a cui si applicano la commissione di configurazione, la commissione ricorrente
o la commissione di ricarica prepagata. Il valore è vuoto per una ricarica prepagata.
Email sviluppatore
developer_email
Lo sviluppatore a cui addebitare la tariffa di configurazione, le tariffe ricorrenti o la ricarica prepagata.
Tipo di commissioni
fees_type
Tipo di commissione. Può trattarsi di una tariffa di configurazione, di una tariffa ricorrente o di una ricarica prepagata. Questa dimensione
sarà null se utilizzata con una metrica diversa da fees.
Fine periodo
period_end
Attualmente disponibile nelle organizzazioni Apigee, non in quelle Apigee hybrid.
Fine del periodo per il quale vengono addebitate le commissioni periodiche. Ad esempio, per una commissione mensile
corrisponde all'ultimo giorno del mese.
Inizio periodo
period_start
Attualmente disponibile nelle organizzazioni Apigee, non in quelle Apigee hybrid.
Inizio del periodo per il quale vengono addebitate le commissioni periodiche. Ad esempio, per una tariffa mensile,
corrisponde al primo giorno del mese.
Valuta delle entrate
x_apigee_mintng_currency
Valuta della commissione di configurazione, della commissione ricorrente o della ricarica prepagata.
ID piano tariffario
x_apigee_mintng_rate_plan_id
Attualmente disponibile nelle organizzazioni Apigee, non in quelle Apigee hybrid.
Il piano tariffario di monetizzazione per lo sviluppatore di app.
Il seguente report personalizzato di esempio mostra la somma dei tassi di monetizzazione in tutte le app dello sviluppatore:
Per ogni app dello sviluppatore, il campione mostra il costo totale di tutte le transazioni a partire dal giorno 1-Apr-2021 to 15-Apr-2021. Il costo viene calcolato in base ai prezzi basati sul consumo configurati nel tuo piano tariffario. Tieni presente che in questo esempio,
la metrica (x_apigee_mintng_rate) è un campo di monetizzazione, ma la dimensione
(developer_app) non lo è. Pertanto, in base ai tuoi
requisiti, puoi generare report con una combinazione di campi di monetizzazione e non monetizzazione.
Puoi anche limitare i risultati in base alle caratteristiche delle metriche utilizzando i filtri.
Per visualizzare le commissioni ricorrenti nei report generati, includi nell'intervallo di date selezionato il giorno successivo all'ultimo giorno del mese o il giorno successivo alla data di scadenza dell'abbonamento, poiché è in questo giorno che vengono addebitate.
Esportazione dei dati di analisi della monetizzazione
In Apigee non devi eseguire ulteriori passaggi per esportare i dati di analisi della monetizzazione. Se esporti i dati di Analytics, Apigee esporta i seguenti campi di monetizzazione insieme ai normali dati di Analytics. Quando le transazioni a pagamento e le transazioni che utilizzano un proxy API vengono esportate insieme, ogni record viene esportato con le metriche e le dimensioni comuni, mentre le altre metriche e dimensioni (non correlate) sono impostate su NULL.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Difficile da capire","hardToUnderstand","thumb-down"],["Informazioni o codice di esempio errati","incorrectInformationOrSampleCode","thumb-down"],["Mancano le informazioni o gli esempi di cui ho bisogno","missingTheInformationSamplesINeed","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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`"]]
