Panoramica dell'analisi delle API Apigee

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Questo argomento introduce Apigee API Analytics.

Video : guarda un breve video per una panoramica dei servizi di analisi delle API Apigee.

Migliora la tua API con l'analisi

L'analisi delle API Apigee raccoglie e calcola un'infinità di informazioni che fluiscono attraverso i proxy API. Puoi visualizzare questi dati con grafici e diagrammi nella UI di Apigee oppure puoi scaricare i dati non elaborati per l'analisi offline con le API Apigee.

Analytics ti aiuta a rispondere a domande comuni, ad esempio:

  • Quali sono le tendenze del mio traffico API nel tempo?
  • Quali sono i metodi API più popolari?
  • Chi sono i miei sviluppatori principali?
  • Quando è più rapido il tempo di risposta dell'API? Più lento?
  • A livello geografico, dove riscontro il maggior traffico API?
  • Quante entrate hanno generato le tue transazioni?

Puoi analizzare i dati per un nome host specifico o per un intero ambiente.

Le risposte a domande come queste ti aiutano a migliorare le API, risolvere problemi e decisioni aziendali relative al programma API.

API Analytics aiuta tutti a migliorare

Attraverso un processo continuo di raccolta, analisi e visualizzazione dei dati, Apigee API Analytics aiuta il tuo team API a migliorare le API e gli sviluppatori di app a migliorare le loro app:

I dati passano dalle app tramite i proxy API e poi l'analisi dei dati aiuta a guidare le azioni di sviluppatori di app, team API, team di operazioni e proprietari di attività.
  • Team API: il team API utilizza i sistemi interni per creare API interessanti. Il team API vuole sapere come funziona il programma API nel complesso, come funzionano le singole API e come migliorare le API.
  • Sviluppatori di app: condividendo informazioni di analisi con gli sviluppatori di app, per offrirti app migliori. Questi sviluppatori innovano con la tua API e creano app creative che contribuiscono ad aumentare le entrate della tua azienda. Analytics aiuta gli sviluppatori di app a sapere qual è il rendimento delle loro app e quanto sono che contribuiscono ai profitti della tua azienda. Gli sviluppatori di app vogliono sapere come migliorare le loro app.
  • Team operativo: il team operativo vuole comprendere i modelli di traffico e anticipare quando aggiungere risorse di backend o apportare altri aggiustamenti critici.
  • Proprietario dell'attività: il proprietario dell'attività vuole capire se il suo investimento in API sta dando i risultati sperati e dove investire in API in futuro.

Come faccio a iniziare a utilizzare Apigee API Analytics?

Il tipo di organizzazione Apigee che utilizzi determinerà i passaggi necessari per iniziare a utilizzare l'analisi dell'API Apigee. Se non sai se utilizzi un'organizzazione Apigee con abbonamento o con pagamento a consumo, contatta l'amministratore dell'organizzazione Apigee.

Utilizzare Apigee API Analytics con un'organizzazione con abbonamento

Se sei un cliente in abbonamento Apigee, l'accesso ad analisi delle API Apigee inclusi nei tuoi diritti di abbonamento e abilitati automaticamente per ciascuno dei tuoi ambienti Apigee.

Puoi accedere ai dati di analisi per la tua organizzazione di abbonamento utilizzando l'interfaccia utente di Apigee, l'interfaccia utente di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere ai miei dati di analisi.

Usa l'analisi delle API Apigee con un'organizzazione con pagamento a consumo

Se sei un cliente Pay-as-you-go, devi attivare l'API Apigee Analytics come componente aggiuntivo a pagamento per iniziare a utilizzare i dati di analisi. Per saperne di più sull'attivazione del componente aggiuntivo Apigee API Analytics per gli ambienti Apigee Intermedio o Completo, consulta Gestire il componente aggiuntivo Apigee API Analytics.

Dopo aver attivato il componente aggiuntivo Apigee API Analytics nei tuoi ambienti, puoi accedere ai tuoi dati di analisi e gestire il componente aggiuntivo Apigee API Analytics utilizzando la UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere ai miei dati di analisi. I dati di analisi e la gestione dei componenti aggiuntivi non sono disponibili nell'interfaccia utente classica di Apigee per le organizzazioni con pagamento a consumo.

Quali tipi di dati vengono raccolti e analizzati?

Apigee API Analytics raccoglie e analizza un ampio spettro di dati che vengono trasmessi tramite i proxy API, ad esempio:

  • Data/ora della risposta
  • Latenza di richiesta
  • Dimensioni richiesta
  • Errori di targeting
  • Nome del prodotto API
  • Indirizzo email dello sviluppatore o ID gruppo di app
  • Nome app
  • Entrate da transazioni

Per un elenco completo dei dati raccolti da API Analytics, consulta Riferimento alle metriche, alle dimensioni e ai filtri di Analytics.

Come faccio a raccogliere i dati di analisi personalizzati?

Apigee raccoglie in modo nativo una vasta gamma di dati. Puoi anche raccogliere dati di analisi personalizzati specifici ai proxy API, alle app, ai prodotti o agli sviluppatori. Ad esempio, potresti voler raccogliere dati di analisi da parametri di ricerca, intestazioni delle richieste, corpi di richieste e risposte o variabili definite nelle API.

Puoi raccogliere dati analitici personalizzati con DataCapture, e poi utilizzare la UI o l'API di analisi per esaminare i dati raccolti.

Quando e per quanto tempo saranno disponibili i miei dati di analisi?

Esistono due intervalli di tempo che controllano quando e per quanto tempo puoi visualizzare i dati di analisi:

  • Intervallo di ritardo dei dati: dopo aver effettuato una chiamata a un proxy API, possono essere necessari fino a 10 minuti prima che i dati siano accessibili per la visualizzazione o tramite le chiamate API.
  • Disponibilità di Analytics: il periodo di tempo durante il quale i dati di analisi (inclusi i Prodotti per la monetizzazione) e i dati Sense, se applicabile) vengono resi disponibili da Apigee varia in base al piano. A seconda del piano sottoscritto, i dati di analisi potrebbero essere disponibili per gli ultimi 30 giorni, 90 giorni o 14 mesi.
di Gemini Advanced.

Conservazione dei dati durante l'utilizzo del componente aggiuntivo di analisi dell'API Apigee

Se hai un'organizzazione con pagamento a consumo, puoi attivare il componente aggiuntivo Apigee API Analytics a livello di ambiente. Una volta attivato il componente aggiuntivo per un ambiente, i dati di analisi per l'ambiente vengono conservati per 14 mesi. Puoi accedere ai dati di analisi storici dell'ambiente dalle Metriche API nella console, purché il componente aggiuntivo sia abilitato.

Se disattivi il componente aggiuntivo Apigee API Analytics per un ambiente in un'organizzazione con pagamento a consumo, i dati di analisi per l'ambiente vengono eliminati dopo 30 giorni. Se riattivi il componente aggiuntivo nello stesso ambiente entro 30 giorni dalla disattivazione, puoi riottenere l'accesso ai dati di analisi per l'ambiente durante il periodo di conservazione di 14 mesi. Nessun dato viene ripristinato se il componente aggiuntivo viene riattivato per l'ambiente dopo 30 giorni.

Se vuoi conservare i dati di analisi per qualsiasi ambiente in un'organizzazione con pagamento a consumo oltre il periodo di conservazione di 14 mesi, ti consigliamo di esportare e salvare i dati in un'altra posizione. Ti consigliamo inoltre di esportare i dati di Analytics prima di disattivare il componente aggiuntivo Apigee API Analytics o entro il periodo di 30 giorni successivo alla disattivazione. Per ulteriori informazioni, consulta Esportare i dati da Analytics.

Dove vengono archiviati ed elaborati i miei dati di analisi?

Il luogo in cui i dati di analisi vengono archiviati ed elaborati è determinato dal tuo analytics che hai specificato al momento dell'installazione di Apigee:

  • Se sei un cliente con abbonamento e hai installato Apigee utilizzando la procedura guidata di provisioning di Apigee, hai specificato la regione di analisi nel passaggio 1 di Crea un'organizzazione, quando hai impostato la regione di hosting di Analytics.
  • Se sei un cliente con pagamento a consumo e hai installato Apigee utilizzando la console Google Cloud, hai specificato la regione di analisi nel terzo passaggio di Crea un'organizzazione, quando hai impostato la regione di hosting di Analytics.
  • Se hai installato Apigee dalla riga di comando come cliente in abbonamento o pagamento a consumo, hai specificato la regione di analisi quando che hai definito la variabile di ambiente ANALYTICS_REGION.

I dati di Analytics vengono archiviati ed elaborati nel seguente modo:

  • Per le regioni di analisi non situate negli Stati Uniti o nell'UE, i dati di analisi vengono archiviati ed elaborati nella regione di analisi.
  • Per le regioni di analisi negli Stati Uniti o nell'UE, i dati vengono archiviati nel Più regioni, rispettivamente, Stati Uniti o UE, per una maggiore disponibilità.

Come faccio ad accedere ai miei dati di analisi?

Apigee API Analytics fornisce strumenti di visualizzazione dei dati integrati nell'interfaccia utente di Apigee. Questi strumenti includono dashboard di analisi predefinite e report personalizzati che visualizzano i dati in grafici e consentono di visualizzare i dati raggruppati in dimensioni diverse (ad esempio per proxy API, indirizzo IP o codice di stato HTTP).

Puoi anche scaricare i dati di analisi utilizzando l'API Apigee. Al termine del download, puoi importare questi dati nei tuoi strumenti di visualizzazione dei dati o nel tuo sistema di analisi.

Dashboard di analisi

L'interfaccia utente di Apigee fornisce un insieme di dashboard predefinite che puoi utilizzare per visualizzare i dati di analisi.

Apigee nella console Cloud

Per aprire le dashboard di Analytics (per le organizzazioni con pagamento a consumo o abbonamento):

  1. Apri la UI di Apigee nella console Cloud in un browser.
  2. Seleziona Analytics > Metriche delle API.
L'immagine seguente mostra la dashboard Rendimento dei proxy API:

Seleziona una delle seguenti schede per visualizzare le dashboard:

Per saperne di più, consulta Utilizzare le dashboard di analisi.

Versione classica di Apigee

Per aprire le dashboard di Dati (solo per le organizzazioni con abbonamento):

  1. Apri l'UI di Apigee in un browser.
  2. Seleziona Analizza > Metriche API.
  3. Seleziona una delle seguenti dashboard:

Oltre a queste, puoi utilizzare anche le seguenti dashboard:

Per ulteriori informazioni, vedi Utilizzare le dashboard di Dati.

Report personalizzati

I report personalizzati ti consentono di visualizzare in dettaglio metriche API specifiche e visualizzare i dati esatti che ti interessano. Puoi creare un report personalizzato utilizzando uno qualsiasi dei dati di analisi integrati in Apigee.

Quando crei un report personalizzato, selezioni i dati che vuoi visualizzare (metriche), raggruppi i dati in modi significativi (dimensioni) e, facoltativamente, limiti i dati restituiti in base a caratteristiche specifiche dei dati (filtri).

Puoi anche impostare il tipo di grafico visualizzato nel report personalizzato come grafico a colonne o a linee. Le seguenti immagini mostrano esempi di grafici per le transazioni al secondo raggruppate per proxy API:

  • Colonna: ogni proxy API è rappresentato da una colonna diversa:

    Grafico a colonne personalizzato

  • Riga: ogni proxy API è rappresentato da una riga diversa:

    Grafico a linee personalizzato

Per saperne di più, consulta Creare e gestire i report personalizzati.

API Analytics

Utilizza l'API Apigee per scaricare i dati di analisi. Ad esempio, puoi utilizzare l'API per creare strumenti di visualizzazione personalizzati da incorporare in portali o app personalizzate.

Di seguito è riportato un esempio di chiamata API per recuperare i dati di analisi per i proxy API:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \
  -H "Authorization: Bearer $TOKEN"

Questa chiamata restituisce:

  • La somma delle richieste (conteggio dei messaggi) per proxy API
  • Per un periodo di 24 ore.
  • Raggruppati per ora

Il parametro di query timeRange specifica il periodo di tempo nel formato:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Osserva %20 prima di HH:MM. Il parametro timeRange richiede un carattere spazio con codifica URL prima di HH:MM o un carattere +, ad esempio:MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Per saperne di più, consulta Utilizzare l'API Metrics.

Esportare i dati di analisi nella piattaforma Google Cloud

Puoi utilizzare l'API Apigee per esportare tutti i dati di analisi per un'intera giornata da Apigee nel tuo repository di dati, ad esempio Google Cloud Storage o BigQuery. Potrai quindi sfruttare le potenti funzionalità di query e machine learning offerte Google Cloud BigQuery e TensorFlow per eseguire l'analisi dei tuoi dati.

Per saperne di più, consulta Esportazione dei dati da Analytics.

Come faccio a condividere i dati con gli sviluppatori di app?

Se consideri gli sviluppatori di app come tuoi clienti, devi assicurarti che abbiano a disposizione gli strumenti e le informazioni necessari per utilizzare al meglio la tua API.

Le app inviano dati tramite proxy API e l'analisi dei dati aiuta uno sviluppatore di app a capire il rendimento della sua app.

Gli sviluppatori di app non sono solo preoccupati della qualità delle loro app, ma sono molto interessati alle tue API. Il portale per gli sviluppatori basato su Drupal include una pagina facoltativa Prestazioni app progettata per consentire agli sviluppatori di app di accedere a: metriche importanti per le sue app. Questa pagina fornisce agli sviluppatori informazioni su:

  • Errori: quali errori dell'API vengono visualizzati nella mia app?
  • Prestazioni: l'API è lenta? Quali metodi API sono in genere lenti o lento adesso?
  • Disponibilità: l'API è attiva o meno?
  • Quota: la tua API ha una quota? E come sviluppatore di app, come sto rispetto alla quota?

Per ulteriori informazioni, vedi Monitora le app nella documentazione di Drupal 8.

Inoltre, puoi condividere dati e analisi con i tuoi sviluppatori nei seguenti modi:

  • Creare report personalizzati e condividerli con gli sviluppatori di app. Per scoprire di più, consulta la pagina Creare e gestire report personalizzati.
  • Utilizzo delle API di misurazione per acquisire i dati su un periodo di tempo più ampio da condividere con gli sviluppatori di app offline. Per ulteriori informazioni, consulta Utilizzare l'API Metrics.

Come faccio a generare dati di analisi completi?

Che cosa intendiamo per analisi complete? Ad esempio, puoi creare un proxy API e Apigee raccogliere dati di analisi su quel proxy. Ma che dire delle metriche per lo sviluppatore o l'app che ha chiamato il proxy API? Se Apigee non sa chi ha effettuato una chiamata API, non può raccogliere questi dati.

Per consentire ad Apigee di capire quali sviluppatori e quali app per sviluppatori chiamano i tuoi proxy API, sono necessari alcuni passaggi. Di seguito è riportato un elenco di questi passaggi con link a informazioni più dettagliate:

  1. Crea uno o più prodotti API, ovvero un raggruppamento di proxy API insieme a un piano di servizio. Consulta Gestire i prodotti API.
  2. Registrazione degli sviluppatori di app con Apigee. Consulta Registrazione degli sviluppatori di app.
  3. Registrazione delle app e gestione delle chiavi API per i tuoi sviluppatori. Consulta la sezione Registrare le app e gestire le chiavi API.
  4. Aggiungi criteri di sicurezza ai proxy API per verificare le chiavi API e/o i token di sicurezza. Consulta i seguenti argomenti: Norme relative a VerifyAPIKey, Norme relative a OAuthV2 e Norme relative a VerifyJWT.

I seguenti tutorial ti guidano attraverso i passaggi necessari per visualizzare i dati e le analisi per sviluppatori e app: Proteggere un'API richiedendo le chiavi API e Proteggere un'API con OAuth.

Requisiti di Apigee hybrid

Questa sezione elenca informazioni importanti per gli utenti ibridi di Apigee.

Supporto per la residenza dei dati

Le versioni precedenti di Apigee Hybrid non supportano Apigee API Analytics.

Altri requisiti

Ulteriori informazioni