Gestisci i report

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Introduzione

I report sulla monetizzazione ti consentono di accedere a informazioni mirate sull'utilizzo e alle attività di transazione. Ad esempio, puoi determinare quali applicazioni, sviluppatori, pacchetti di prodotti API o prodotti API hanno avuto attività di transazione per un determinato intervallo di date. Con la monetizzazione, puoi generare un riepilogo Report 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 di Apigee Edge, la conservazione dei dati di monetizzazione è un diritto relativo a un piano. Consulta le dei diritti di monetizzazione all'indirizzo https://cloud.google.com/apigee/specsheets. Contatta il team di vendita Apigee se vuoi che i dati di monetizzazione vengano conservati oltre il diritto punto. La conservazione estesa dei dati viene attivata al momento della richiesta e non può essere attivata in modo retroattivo per includere i dati precedenti alla finestra di conservazione dei dati originale.

Informazioni sulle transazioni duplicate

Se confronti i report sulle transazioni di monetizzazione con i dati di Analytics, potresti notare una piccola di transazioni duplicate. Si tratta di un comportamento previsto, in quanto il sistema di monetizzazione può elaborare diversi milioni di transazioni ogni giorno, con molte transazioni elaborate in parallelo in qualsiasi momento. In media, circa lo 0,1% delle transazioni potrebbe essere costituito da duplicati.

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 di Edge o l'interfaccia utente classica di Edge.

Configurazione di 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 sulle entrate

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

Inclusione di attributi transazioni personalizzati nei report di riepilogo delle entrate

I criteri di registrazione delle transazioni ti consentono di acquisire i dati degli attributi personalizzati dalle transazioni e di includere questi attributi personalizzati nei report di riepilogo delle 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 consulta le considerazioni riportate 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 le 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 funzione e aggiunge partner_id e tax_source colonne alla di monetizzazione. Tieni presente che l'array di attributi personalizzati nella chiamata dell'API è codificato in URL.

Considerazioni per l'inclusione di attributi delle transazioni personalizzati nei report

• Assicurarsi dei nomi degli attributi da utilizzare prima di crearli con l'API. Si tratta dei nomi delle colonne nel database, dove vengono sempre archiviati i dati degli attributi personalizzati.
• Sono disponibili 10 slot per attributi personalizzati in ogni criterio di registrazione delle transazioni, come mostrato nell'immagine di seguito. Utilizza gli stessi nomi e le stesse posizioni degli attributi per gli stessi attributi tra i prodotti che verranno inclusi nei report. Ad esempio, nel seguente di registrazione delle transazioni, i valori personalizzati partner_id e tax_source occupano, rispettivamente, i riquadri 4 e 5. Dovrebbero essere il loro nome e la loro posizione le norme di registrazione delle transazioni per i prodotti da includere nei report.
  
  

Per includere gli attributi personalizzati in un report sulle entrate di riepilogo dopo aver attivato la funzionalità, utilizza l'API report aggiungendo transactionCustomAttributes al MintCriteria. Consulta Configurazione dei criteri opzioni.

Configurazione di un report sulle variazioni (disponibile solo in alcuni paesi) (ritirato)

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 scaricare i risultati in formato CSV o ZIP. Puoi generare il file CSV o ZIP in modo sincrono o asincrono.

• Per un report sincrono, la richiesta viene eseguita e bloccata fino a quando 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 non riuscire a causa di un timeout.

  Un livello di report Riepilogo supporta solo la generazione sincrona.

• Per un report asincrono, esegui la richiesta del report e recupera i risultati in un secondo momento. Alcune situazioni in cui l'elaborazione asincrona delle query potrebbe essere una buona alternativa sono:

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

  Un livello di report Dettagliato supporta la generazione asincrona.

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

1. Accedi alla pagina Report.
2. Posiziona il cursore sopra il report che vuoi scaricare.

3. Nella colonna Modificato, fai clic su:

   1. o l'icona (per un report di riepilogo). Il report viene salvato in un file CSV o ZIP in modo sincrono.
   2. Invia job (per un report 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 viene riportato un esempio di file CSV per un report di riepilogo sulla 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 delle azioni.
3. Aggiorna la configurazione del report, se necessario.
4. Fai clic su Aggiorna report per salvare la configurazione aggiornata del report.

Eliminare un report

Per eliminare un report:

1. Accedi alla pagina Report.
2. Posiziona il cursore sul report che vuoi eliminare.
3. Fai clic su nel menu delle azioni.

Gestione dei report sulla monetizzazione tramite l'API

Le sezioni seguenti 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, puoi specificare criteri nel mintCriteria che configura ulteriormente il report. Puoi specificare una vasta gamma di criteri. Questo ti offre molta flessibilità nella configurazione del report. Ecco alcuni elementi che puoi specificare come criteri:

• Per un report sulla fatturazione o sul saldo prepagato, il mese di fatturazione del report
• In un report Entrate, il tipo di transazioni incluse nel report, ad esempio acquisto transazioni, addebiti per transazioni e rimborsi
• Per un report sul saldo prepagato, lo sviluppatore a cui si applica il report
• Per un report sulle entrate, i set 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 sulle variazioni, la valuta applicabile al report
• Per i report di fatturazione, sul saldo con pagamento anticipato o sulle entrate, se il report è un riepilogo o un report dettagliato
• Per un report di riepilogo delle entrate, includi gli attributi di transazione personalizzati nel report

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

Ad esempio, quanto segue crea un report Entrate che riassume l'attività di transazione per il mese di luglio 2015. Il report include vari tipi di transazioni specificati negli transactionTypes e si applica in particolare al pacchetto di prodotti e all'API Payment Prodotto API Payment. Perché nel report non sono specificati sviluppatori o applicazioni specifici definizione, il report si applica a tutti gli sviluppatori e le applicazioni. Poiché la proprietà currencyOption è impostata su LOCAL, ogni riga del report verrà visualizzata utilizzando la valuta del piano tariffario applicabile. Inoltre, groupBy specifica che le colonne del report verranno raggruppate nella nell'ordine seguente: PACKAGE, PRODOTTO, SVILUPPATORI, APPLICAZIONE e RATEPLAN (include il nome del piano tariffario) e ID 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 un DEV sviluppatore CINQUE 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 per 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} indica l'identificazione della configurazione specifica del report (il 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 dei 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, il seguente comando restituisce le configurazioni dei report per l'organizzazione e limita il recupero a un massimo di cinque configurazioni dei 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 avere un aspetto simile al seguente (è mostrata solo una parte della risposta):

{
  "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 sopra per filtrare e ordinare i dati.

Ad esempio, il seguente comando 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

Aggiornamento della 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 del report specifica. Quando aggiornare, specificare nel corpo della richiesta i valori di configurazione aggiornati e l'ID la configurazione del report. Ad esempio, la seguente richiesta aggiorna il report a 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 avere un aspetto simile al seguente (è mostrata solo una parte della risposta):

{
 "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 del 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 utilizzando l'API

Dopo aver configurato un report, puoi generarlo utilizzando 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 tipo di report che desideri 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 funzionalità di mintCriteria per specificare i criteri di ricerca. Per ulteriori dettagli, consulta Opzioni di configurazione dei criteri.

Ad esempio, la seguente richiesta cerca un report sulle entrate in base a vari criteri quali le date di inizio e di fine del rapporto 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 viene trovato, il report sulle 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 sulle entrate tramite l' API

Solo per i report Entrate, puoi includere attributi personalizzati nel report, se l'impostazione personalizzata viene definito per lo sviluppatore. Puoi definire gli attributi personalizzati quando aggiungi sviluppatori a la tua organizzazione, come descritto in Gestire gli sviluppatori di app.

Per includere attributi personalizzati in un report sulle entrate, invia una richiesta POST a organizations/{org_name}/revenue-reports e includi 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 viene fornito un esempio dell'output del report che include i valori dei due valori personalizzati attributi:

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,

Generazione di report sull'attività di transazione tramite l'API

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

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

Consulta le Opzioni di configurazione dei criteri per un elenco completo criteri.

Ad esempio, la seguente 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, set di prodotti API o prodotti API hanno avuto attività di transazione in un determinato intervallo di date. Puoi visualizzare queste informazioni separatamente per ogni e il tipo di oggetto. Ad esempio, puoi visualizzare informazioni specifiche sulle applicazioni che accedono alle API nei tuoi set di prodotti API monetizzati entro una data di inizio e di fine specificata.

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

Quando emetti la richiesta, devi specificare come parametri di query una data di inizio e una data di fine. per l'intervallo di date. Ad esempio, la seguente richiesta restituisce gli sviluppatori con 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 avere un aspetto simile al seguente (è mostrata solo una parte della risposta):

{
  "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

Le seguenti opzioni di configurazione sono disponibili per i report tramite mintCriteria proprietà:

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

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