Gestisci i report

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Introduzione

I report sulla monetizzazione ti consentono di accedere a informazioni specifiche sull'utilizzo e alle attività delle transazioni. Ad esempio, puoi determinare quali applicazioni, sviluppatori, pacchetti di prodotti API o prodotti API hanno registrato attività di transazione per un determinato intervallo di date. Con la monetizzazione, puoi generare report di riepilogo o dettagliati che monitorano l'utilizzo dell'API.

Tipi di report sulla monetizzazione

Puoi generare i seguenti tipi di report sulla monetizzazione.

Informazioni sulla conservazione dei dati

Nel cloud pubblico Apigee Edge, la conservazione dei dati di monetizzazione è un diritto del piano. Consulta i diritti di monetizzazione all'indirizzo https://cloud.google.com/apigee/specsheets. Contatta il team di vendita di Apigee se vuoi che i dati di monetizzazione vengano conservati oltre il periodo di diritto. La conservazione estesa dei dati viene attivata al momento della richiesta e non può essere attivata retroattivamente per includere i dati precedenti al periodo di conservazione dei dati originale.

Esplorare la pagina Report sulla monetizzazione

Accedi alla pagina Report sulla monetizzazione, come descritto di seguito.

Configurare un report

Configura un report utilizzando l'interfaccia utente, come descritto nelle sezioni seguenti.

Passaggi per configurare un report

Configura un report utilizzando l'interfaccia utente Edge o la UI classica di Edge.

Configurare un report di fatturazione

Segui i passaggi per configurare un report e inserisci le seguenti informazioni nella pagina del report:

Configurare un report sul saldo prepagato

Configurare un report Entrate

Segui i passaggi per configurare un report e inserisci le seguenti informazioni nella pagina del report:

Inclusione di attributi personalizzati delle transazioni nei report di riepilogo delle entrate

Le norme di registrazione delle transazioni consentono di acquisire dati sugli attributi personalizzati delle transazioni e puoi includere questi attributi personalizzati nei report riepilogativi sulle entrate. Definisci l'insieme predefinito di attributi personalizzati inclusi nelle tabelle del database di monetizzazione impostando la proprietà MINT.SUMMARY_CUSTOM_ATTRIBUTES per la tua organizzazione.

L'utilizzo di questa funzionalità richiede un po' di riflessione e pianificazione, quindi esamina le considerazioni di seguito.

Se sei un cliente cloud, contatta l'assistenza Apigee Edge per impostare la proprietà. Se sei un cliente Apigee Edge per il cloud privato, imposta il flag utilizzando una richiesta PUT alla seguente API con credenziali di amministratore di sistema.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

In questo esempio, la chiamata API abilita la funzionalità e aggiunge le colonne partner_id e tax_source al database di monetizzazione. Tieni presente che l'array di attributi personalizzati nella chiamata API è con codifica URL.

Considerazioni per l'inclusione degli attributi delle transazioni personalizzate nei report

• Accertati dei nomi degli attributi che vuoi utilizzare prima di crearli con l'API. Si tratta dei nomi di colonna nel database in cui i dati degli attributi personalizzati vengono sempre archiviati al suo interno.
• Sono disponibili 10 slot di attributi personalizzati in ogni criterio di registrazione delle transazioni, come mostrato nell'immagine seguente. Utilizza esattamente gli stessi nomi e le stesse posizioni degli attributi per gli stessi attributi per tutti i prodotti che saranno inclusi nei report. Ad esempio, nel seguente criterio di registrazione delle transazioni, gli attributi personalizzati partner_id e tax_source occupano rispettivamente i riquadri 4 e 5. Devono essere il loro nome e la loro posizione in tutte le norme di registrazione delle transazioni per i prodotti da includere nei report.
  
  

Per includere gli attributi personalizzati in un report di riepilogo sulle entrate dopo aver attivato la funzionalità, utilizza l'API del report aggiungendo transactionCustomAttributes a MintCriteria. Vedi Opzioni di configurazione dei criteri.

Configurare un report sulla varianza (deprecato)

Segui i passaggi per configurare un report e inserisci le seguenti informazioni nella pagina del report:

Generazione e download di un report

Dopo aver creato un report, puoi scaricarlo in formato file CSV o ZIP. Puoi generare il file CSV o ZIP in modo sincrono o in modo asincrono.

• Per un report sincrono, esegui la richiesta di report, che viene bloccata finché il server di analisi non fornisce una risposta. Tuttavia, poiché un report potrebbe dover elaborare una grande quantità di dati (ad esempio centinaia di GB), un report sincrono potrebbe restituire errori a causa di un timeout.

  Un livello di report Riepilogo supporta solo la generazione sincrona.

• Per un report asincrono, puoi eseguire la richiesta di report e recuperare i risultati in un secondo momento. Ecco alcune situazioni in cui l'elaborazione asincrona delle query potrebbe essere una buona alternativa:

  • Analisi e creazione di report che coprono intervalli di tempo ampi.
  • Analisi dei dati con una varietà di dimensioni di raggruppamento e altri vincoli che aggiungono complessità alla query.
  • Gestione delle query quando rilevi che i volumi di dati sono aumentati in modo significativo per alcuni utenti o alcune organizzazioni.

  Un livello di report Dettagliato supporta la generazione asincrona.

Per generare e scaricare un report in formato file CSV o ZIP, esegui una delle seguenti attività:

1. Accedi alla pagina Report.
2. Posiziona il cursore sul report da scaricare.

3. Nella colonna Modificate, fai clic su:

   1. L'icona o (per un report di riepilogo). Il report viene salvato in modo sincrono in un file CSV o ZIP.
   2. Invia job (per un rapporto dettagliato). Viene avviato il job asincrono.

      1. Monitora lo stato del job nella colonna Modificato.

         L'icona del disco viene visualizzata quando il report è pronto per il download:

         
      2. Al termine del job, fai clic sull'icona del disco per scaricare il report.

Di seguito è riportato un esempio di file CSV per un report di riepilogo della fatturazione.

Modificare un report

Per modificare un rapporto:

1. Accedi alla pagina Report.
2. Posiziona il cursore sul report da modificare e fai clic su nel menu Azioni.
3. Aggiorna la configurazione del report come richiesto.
4. Fai clic su Aggiorna report per salvare la configurazione del report aggiornata.

Eliminare un report

Per eliminare un report:

1. Accedi alla pagina Report.
2. Posiziona il cursore sul report da eliminare.
3. Fai clic su nel menu Azioni.

Gestire i report sulla monetizzazione utilizzando l'API

Le seguenti sezioni descrivono come gestire i report sulla monetizzazione utilizzando l'API.

Configurare un report utilizzando l'API

Per configurare un report per un'intera organizzazione, invia una richiesta POST a /organizations/{org_name}/report-definitions.

Per configurare un report per uno sviluppatore specifico, invia una richiesta POST a /organizations/{org_name}/developers/{dev_id}/report-definitions, dove {dev_id} è l'identificazione dello sviluppatore.

Quando effettui la richiesta, devi specificare il nome e il tipo di report. Il tipo è uno dei seguenti: BILLING, REVENUE, VARIANCE (deprecato) o PREPAID_BALANCE. Inoltre, nella proprietà mintCriteria puoi specificare criteri che configurano ulteriormente il report. È possibile specificare un'ampia gamma di criteri. Questo ti offre molta flessibilità nella configurazione del report. Alcuni elementi che puoi specificare come criteri sono:

• Per un report di fatturazione o saldo prepagato, il mese di fatturazione del report
• Per un report Entrate, il tipo di transazioni coperte dal report, ad esempio transazioni di acquisto, transazioni di addebito e rimborsi
• Nel caso di un report sul saldo prepagato, lo sviluppatore a cui si applica il report.
• Per un report sulle entrate, i pacchetti di prodotti API (o pacchetti API), i prodotti, i piani tariffari e le applicazioni a cui si applica il report
• Per un report sulle entrate o sulla varianza, la valuta applicabile al report.
• Per la fatturazione, il saldo prepagato o i report Entrate, sia che si tratti di un report di riepilogo o di un report dettagliato
• Per un report di riepilogo delle entrate, includi nel report gli attributi personalizzati delle transazioni

Consulta Opzioni di configurazione dei report per un elenco completo dei criteri del report.

Ad esempio, quanto riportato di seguito crea un report sulle entrate che riassume l'attività delle transazioni per il mese di luglio 2015. Il report include una serie di tipi di transazioni specificati nella proprietà transactionTypes e si applica in modo specifico al pacchetto di prodotti dell'API Payment e al prodotto dell'API Payment. Poiché nella definizione del report non sono specificati sviluppatori o applicazioni specifici, quest'ultimo si applica a tutti gli sviluppatori e a tutte le applicazioni. Inoltre, poiché la proprietà currencyOption è impostata su LOCAL, ogni riga del report verrà visualizzata utilizzando la valuta del piano tariffario applicabile. Inoltre, la proprietà groupBy specifica che le colonne nel report verranno raggruppate nel seguente ordine: PACKAGE, PRODUCT, SVILUPPO, APPLICATION e RATEPLAN (sono inclusi il nome e l'ID del piano tariffario nel report).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

Di seguito viene creato un report di fatturazione dettagliato che mostra l'attività di uno sviluppatore DEV FIVE per giugno 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

Visualizzare le configurazioni dei report utilizzando l'API

Puoi visualizzare una configurazione di report specifica o tutte le configurazioni di report di un'organizzazione. Puoi anche visualizzare le configurazioni dei report per un singolo sviluppatore.

Per visualizzare una configurazione di report specifica per un'organizzazione, invia una richiesta GET a /organizations/{org_name}/report-definitions/{report_definition_id}, dove {report_definition_id} è l'identificazione della configurazione di report specifica (l'ID viene restituito nella risposta quando crei la configurazione del report). Ad esempio:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Per visualizzare tutte le configurazioni di report per l'organizzazione, invia una richiesta GET a /organizations/{org_name}/report-definitions.

Puoi passare i seguenti parametri di query per filtrare e ordinare i risultati:

Ad esempio, quanto riportato di seguito restituisce le configurazioni di report per l'organizzazione e limita il recupero a un massimo di cinque configurazioni di report:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

La risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Per visualizzare le configurazioni dei report per uno sviluppatore specifico, invia una richiesta GET a /organizations/{org_name}/developers/{dev_id}/report-definitions, dove {dev_id} è l'identificazione dello sviluppatore. Quando effettui la richiesta, puoi specificare i parametri di query descritti in precedenza per filtrare e ordinare i dati.

Ad esempio, la seguente dichiarazione restituisce le configurazioni dei report per uno sviluppatore specifico e ordina la risposta in base al nome del report:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

Aggiornare la configurazione di un report utilizzando l'API

Per aggiornare una configurazione di report, invia una richiesta PUT a /organizations/{org_name}/report-definitions/{report_definition_id}, dove {report_definition_id} è l'identificazione della configurazione specifica del report. Quando esegui l'aggiornamento, devi specificare nel corpo della richiesta i valori di configurazione aggiornati e l'ID della configurazione del report. Ad esempio, la seguente richiesta aggiorna il report in un report di riepilogo (le proprietà aggiornate sono evidenziate):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

La risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

Eliminare una configurazione di report utilizzando l'API

Per eliminare una configurazione di report, invia una richiesta DELETE a /organizations/{org_namer}/report-definitions/{report_definition_id}, dove {report_definition_id} è l'identificazione della configurazione del report da eliminare. Ad esempio:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Generazione di un report tramite l'API

Dopo aver configurato un report, puoi generarlo in formato file con valori separati da virgole (CSV) per la visualizzazione.

Per generare un report, invia una richiesta POST a organizations/{org_id}/{report_type}, dove {report_type} specifica il tipo di report che vuoi generare. I tipi sono:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Ad esempio, per generare un report di fatturazione, invia una richiesta POST a organizations/{org_name}/billing-reports.

Nel corpo della richiesta (per qualsiasi tipo di report), specifica i criteri di ricerca per il report. Utilizza le proprietà mintCriteria per specificare i criteri di ricerca. Per ulteriori dettagli, vedi Opzioni di configurazione dei criteri.

Ad esempio, la seguente richiesta cerca un report sulle entrate in base a vari criteri, come le date di inizio e di fine del report e i tipi di transazioni.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Se lo trovi, il report Entrate viene generato in formato file CSV. Di seguito è riportato un esempio dell'output del report:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Inclusione degli attributi personalizzati dello sviluppatore nei report Entrate utilizzando l'API

Solo per i report Entrate, puoi includere attributi personalizzati nel report, se l'attributo personalizzato è definito per lo sviluppatore. Gli attributi personalizzati vengono definiti quando si aggiungono sviluppatori all'organizzazione, come descritto in Gestire gli sviluppatori di app.

Per includere attributi personalizzati in un report Entrate, invia una richiesta POST a organizations/{org_name}/revenue-reports e includi l'array devCustomAttributes nel corpo della richiesta:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Nota: non specificare gli attributi MINT_* e ADMIN_* predefiniti nell'array devCustomAttributes.

Ad esempio, l'esempio seguente include tre attributi personalizzati, BILLING_TYPE, SFID e ORG_EXT, nel report (se definiti per lo sviluppatore):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Di seguito è riportato un esempio dell'output del report che include i valori per i due attributi personalizzati:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

Segnalare le attività di transazione utilizzando l'API

Puoi visualizzare l'attività delle transazioni per un'organizzazione inviando una richiesta POST a /organizations/{org_name}/transaction-search. Quando effettui la richiesta, devi specificare i criteri per il recupero. Alcuni elementi che puoi specificare come criteri sono:

• ID di uno o più prodotti API per i quali sono state emesse le transazioni.
• Mese e anno di fatturazione delle transazioni.
• Sviluppatore o sviluppatori che hanno emesso la transazione.
• Tipo di transazione, ad esempio commissioni di acquisto e di configurazione.
• Lo stato della transazione, ad esempio riuscita e non riuscita.

Vedi Opzioni di configurazione dei criteri per un elenco completo dei criteri.

Ad esempio, quanto segue restituisce le transazioni emesse da uno sviluppatore specifico per il mese di fatturazione di giugno 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Puoi anche determinare quali applicazioni, sviluppatori, pacchetti di prodotti API o prodotti API hanno registrato attività di transazione in un determinato intervallo di date. Puoi visualizzare queste informazioni separatamente per ogni tipo di oggetto. Ad esempio, puoi visualizzare informazioni specifiche sulle applicazioni che accedono alle API nei pacchetti di prodotti API monetizzati entro una data di inizio e una data di fine specificate.

Per visualizzare le informazioni sull'attività delle transazioni, invia una richiesta GET a una delle seguenti risorse:

Quando invii la richiesta, devi specificare come parametri di ricerca una data di inizio e una data di fine per l'intervallo di date. Ad esempio, la seguente richiesta restituisce gli sviluppatori che hanno effettuato transazioni durante il mese di agosto 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

La risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

Opzioni di configurazione dei report per l'API

L'API ha a disposizione le seguenti opzioni di configurazione dei report:

Opzioni di configurazione dei criteri

Per i report tramite la proprietà mintCriteria sono disponibili le seguenti opzioni di configurazione:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]