Panoramica dell'analisi delle API Apigee

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

Questo argomento introduce l'analisi delle API Apigee.

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:

  • Qual è l'andamento del mio traffico API nel tempo?
  • Quali sono i metodi API più popolari?
  • Chi sono i miei sviluppatori principali?
  • Qual è il tempo di risposta più rapido dell'API? Più lento?
  • A livello geografico, dove vedo la maggior parte del 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.

L'analisi delle API aiuta tutti a migliorare

Attraverso un processo continuo di raccolta, analisi e visualizzazione dei dati, Apigee API Analytics aiuta il team dedicato all'API migliora le API e aiuta gli sviluppatori di app a migliorare le proprie app:

Flussi di dati da
le app tramite proxy API e poi l'analisi dei dati per guidare le azioni degli sviluppatori di app, dei team dedicati alle API,
team operativi e proprietari di attività commerciali.
  • Team API - Il team API sta sfruttando i sistemi interni per creare API interessanti. Il team dedicato alle API vuole conoscere l'andamento complessivo del programma API, delle singole API e su come migliorare le API.
  • Sviluppatori di app: condividendo informazioni di analisi con gli sviluppatori di app, per offrirti app migliori. Questi sviluppatori stanno innovando con la tua API e creando app creative che ti aiutano a generare per 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 possono migliorare le loro app.
  • Team operativo: il team operativo vuole comprendere i modelli di traffico e prevedere quando aggiungere risorse di backend o apportare altre modifiche critiche.
  • Proprietario dell'attività: il proprietario dell'attività vuole scoprire in che modo Gli investimenti nelle API stanno dando i loro frutti e dove investire dollari in queste API in futuro.

Come faccio a iniziare a utilizzare l'analisi delle API Apigee?

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

Usa l'analisi delle API Apigee con un'organizzazione in 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 analitici della tua organizzazione in abbonamento utilizzando la UI di Apigee, UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere? i miei dati di analisi.

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

Se sei un cliente con Pay-as-you-go, devi: abilita l'analisi dell'API Apigee come componente aggiuntivo a pagamento per iniziare a utilizzare i dati di analisi. Per ulteriori informazioni sull'abilitazione del componente aggiuntivo Apigee API Analytics per le tue applicazioni Apigee intermedie o complete ambienti, consulta Gestire il componente aggiuntivo di analisi delle API Apigee.

Una volta abilitato il componente aggiuntivo di analisi dell'API Apigee nei tuoi ambienti, potrai accedere i tuoi dati di analisi e gestire il componente aggiuntivo di analisi delle API Apigee utilizzando la UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere? i miei dati di analisi. La gestione dei componenti aggiuntivi e dei dati di analisi non è disponibile nella UI classica di Apigee per le organizzazioni con pagamento a consumo.

Che tipo di dati vengono raccolti e analizzati?

L'analisi delle API Apigee raccoglie e analizza un ampio spettro di dati che fluisce attraverso proxy API come:

  • Data/ora della risposta
  • Latenza di richiesta
  • Dimensioni richiesta
  • Errori di targeting
  • Nome del prodotto API
  • Indirizzo email dello sviluppatore o ID AppGroup
  • 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 si raccolgono 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 tuoi dati di analisi:

  • Intervallo di ritardo dei dati: dopo una chiamata a un proxy API, possono essere necessarie fino a 10 minuti affinché i dati siano accessibili per la visualizzazione o tramite 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.

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

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

Se disabiliti il componente aggiuntivo di analisi delle API Apigee 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 entro 30 giorni dalla disattivazione, puoi recuperare l'accesso ai dati di analisi per l'ambiente durante il periodo di conservazione di 14 mesi. Se il componente aggiuntivo viene riattivato per l'ambiente dopo 30 giorni, i dati non vengono ripristinati.

Se vuoi conservare i dati di analisi per qualsiasi ambiente di un'organizzazione con pagamento a consumo oltre il periodo di conservazione di 14 mesi, ti consigliamo di: esporti e salvi i dati in un'altra posizione. Ti consigliamo inoltre di esportare i dati di Analytics prima di disattivare componente aggiuntivo di analisi delle API Apigee o entro la finestra di 30 giorni dopo la disabilitazione. Per ulteriori informazioni, vedi Esportazione dei 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 in abbonamento e hai installato Apigee utilizzando la procedura guidata di provisioning di Apigee, hai specificato la regione di analisi in Crea una organizzazione al passaggio 1, quando imposti la regione hosting Analytics.
  • Se sei un cliente con pagamento a consumo e hai installato Apigee utilizzando la console Google Cloud, hai specificato la regione di analisi in Crea una organizzazione al passaggio 3, quando imposti la regione hosting 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 al di fuori degli Stati Uniti o dell'UE, i dati di analisi vengono archiviati ed elaborati nella regione di Analytics.
  • 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?

L'analisi delle API Apigee fornisce strumenti di visualizzazione dei dati integrati nella UI di Apigee. Questi strumenti includono dashboard di analisi predefinite e report personalizzati che mostrano i dati in grafici e tabelle visualizzare in dettaglio i dati raggruppati in diverse dimensioni (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 nel tuo sistema di analisi o nei tuoi strumenti di visualizzazione dei dati.

Dashboard di analisi

La UI 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 l'UI di Apigee nella console Cloud in un browser.
  2. Seleziona Analytics > metriche delle API.
L'immagine seguente mostra Prestazioni del proxy API dashboard:

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 Analytics (solo per le organizzazioni che richiedono un abbonamento):

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

Oltre a questi, puoi utilizzare anche le seguenti dashboard:

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

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 qualsiasi dato di analisi integrato in Apigee.

Quando crei un report personalizzato, devi selezionare i dati che vuoi visualizzare (metriche e raggruppare i dati in in modi significativi (dimensioni) e, facoltativamente, limitare i dati restituiti in base a caratteristiche specifiche dei dati (applicazione di 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 Creazione e gestione dei report personalizzati.

API Analytics

Utilizzare 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 dello spazio codificato nell'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.

Esporta i dati di analisi nella Google Cloud Platform

Puoi utilizzare l'API Apigee per esportare tutti i dati di analisi per un'intera giornata da Apigee al 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 ulteriori informazioni, consulta Esportazione di dati da Analytics.

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

Quando pensi agli sviluppatori di app come ai tuoi clienti, devi assicurarti che dispongano degli strumenti e le informazioni a loro disposizione per sfruttare al meglio l'API.

Le app inviano dati
tramite proxy API e l'analisi dei dati aiuta gli sviluppatori di app a capire
sta facendo.

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 offre agli sviluppatori informazioni su:

  • Errori. Quali errori relativi all'API vengono rilevati dalla mia app?
  • Prestazioni: l'API è lenta? Quali metodi API sono in genere lenti o lento adesso?
  • Disponibilità: l'API è attiva o non attiva?
  • Quota: la tua API prevede una quota? In qualità di sviluppatore di app, come sto andando 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 saperne di più, consulta Creazione e gestione dei report personalizzati.
  • Utilizzo delle API delle metriche per acquisire dati per un periodo di tempo più ampio da condividere offline con gli sviluppatori di app. Per ulteriori informazioni, consulta Utilizzare l'API Metrics.

Come faccio a generare dati analitici completi?

Che cosa si intende per analisi completa? Ad esempio, puoi creare un proxy API e Apigee raccogliere dati di analisi su quel proxy. E le 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.

Sono necessari alcuni passaggi per consentire ad Apigee di individuare gli sviluppatori e le app degli sviluppatori per chiamare i proxy API. 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 basati su API.
  2. Registrazione degli sviluppatori di app in Apigee. Consulta la sezione Registrazione degli sviluppatori di app.
  3. Registrazione di app e gestione delle chiavi API per gli sviluppatori. Consulta Registrare 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: criterioVerifyAPIKey, criterio OAuthV2 e criterioVerifyJWT.

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

Ulteriori informazioni