L'API Statistiche, disponibile per i clienti di Statistiche+, consente di importare le metriche relative alle chiamate e agli utenti direttamente nei propri strumenti di reporting, senza esportare manualmente i dati dal Dashboard Aircall. È possibile automatizzare estrazioni ricorrenti con cadenza giornaliera, settimanale o mensile e utilizzare i dati per creare report personalizzati in base alle esigenze aziendali.
Questo articolo descrive le funzionalità dell'API Statistiche, il suo funzionamento e gli aspetti da considerare quando si configurano esportazioni automatiche.
Importante: L'API Statistiche è disponibile esclusivamente per i clienti che dispongono dell'Add-on Statistiche+. Se non sai se il tuo Piano include Statistiche+, contatta il Team Successo del cliente.
Cosa è possibile esportare
L'API consente di accedere a tre categorie di dati:
- Cronologia: registri dettagliati delle chiamate In entrata e delle Chiamate in uscita.
- User Status History+: un registro dello Stato di disponibilità degli Agenti nel tempo.
- Attività utente+: un insieme di metriche sulle Prestazioni di ciascun utente, tra cui Volume delle chiamate, tempo in chiamata, tempo di Lavoro post-chiamata, tentativi di chiamata e tempo trascorso in ogni stato.
Ogni categoria corrisponde ai report disponibili nel Dashboard Aircall. Per l'elenco completo dei report esportabili e dei rispettivi valori dei parametri API, consulta la documentazione dell'API Statistiche.
Come iniziare: generare una chiave API
Per utilizzare l'API Statistiche, è necessaria una chiave API. Questa chiave identifica Il mio conto e autorizza le richieste. Puoi creare e gestire le Chiavi API direttamente nel Dashboard Aircall.
Importante: Il token segreto API viene visualizzato una sola volta, subito dopo la creazione. Copialo e conservalo in modo sicuro prima di lasciare la pagina, poiché non sarà possibile recuperarlo in seguito.
Passaggi:
- Vai a Dashboard Aircall > Integrazioni > Chiavi API.
- Fai clic su Genera una chiave API sotto la tabella Chiavi API.
- Assegna alla chiave un nome riconoscibile, ad esempio il nome dello strumento o dello script che la utilizzerà.
- Copia il token segreto API e conservalo in un luogo sicuro.
La chiave apparirà quindi nell'elenco Chiavi API. Trasmetti il token segreto nell'intestazione di autorizzazione delle richieste API. Per tutti i dettagli tecnici, consulta la documentazione dell'API Statistiche.
Come funziona un'esportazione
Le esportazioni dall'API Statistiche seguono una semplice procedura in tre passaggi. I dati vengono preparati in modo asincrono: il file viene generato in background anziché essere restituito immediatamente.
- Richiedi l'esportazione. Specifica il report desiderato e l'intervallo di date. L'API restituisce un ID di esportazione univoco.
- Controlla quando è pronta. Utilizza l'ID di esportazione per verificare lo stato della richiesta. Quando lo stato risulta completato, il file è pronto.
- Scarica il CSV. Recupera il link per il download dalla risposta sullo stato e scarica il file.
L'intera procedura richiede in genere da pochi secondi a pochi minuti, a seconda dell'intervallo di date e del volume di dati.
Importante: Il link per il download scade 1 ora dopo essere stato generato. Scarica il file non appena è pronto.
Filtri e intervalli di date
Ogni richiesta API richiede i seguenti parametri:
- Tipo di report: il report specifico che desideri esportare. Consulta l'elenco completo nella documentazione dell'API Statistiche.
- Intervallo di date: il periodo di tempo che l'esportazione deve coprire.
- Fuso orario: il fuso orario applicato ai dati. Se non specificato, il valore predefinito è UTC.
Puoi inoltre trasmettere filtri facoltativi per restringere i risultati, in linea con i filtri disponibili per ciascun report nel Dashboard Aircall. I filtri facoltativi disponibili variano in base al tipo di report. Consulta la documentazione dell'API Statistiche per l'elenco completo relativo a ciascun report.
Importante: Le richieste prive di un parametro obbligatorio non andranno a buon fine. Verifica ogni tipo di report con tutti i parametri richiesti prima di programmare le esportazioni automatiche.
Conservazione dei dati
I dati esportati coprono lo stesso periodo di quelli visibili nel Dashboard Aircall:
| Area del report | Periodo di conservazione |
|---|---|
| Cronologia | 6 mesi |
| User Status History+ | 7 giorni |
| Attività utente+ | Illimitato |
Buone pratiche
Le seguenti raccomandazioni si applicano sia alle esportazioni una tantum sia alla creazione di una pipeline completamente automatizzata.
Configura la pianificazione nel tuo sistema
L'API non pianifica automaticamente le esportazioni. Se desideri eseguire le esportazioni con cadenza giornaliera, settimanale o mensile, dovrai configurarle nel tuo sistema o strumento di Automazione.
Pianifica le esportazioni nelle ore di minore attività
Se possibile, avvia le esportazioni automatiche Al di fuori dell'orario lavorativo. Ciò riduce il rischio di ritardi durante i periodi di carico elevato dell'API e contribuisce a garantire una disponibilità costante dei dati.
Scarica subito dopo ogni richiesta
Il link per il download scade dopo 1 ora. Configura l'Automazione in modo che scarichi il file non appena viene ricevuta la risposta dell'API, anziché memorizzare il link per recuperarlo in seguito.
Verifica i limiti di righe del sistema di destinazione
L'API non impone un limite di righe alle esportazioni. Tuttavia, alcuni strumenti di importazione e applicazioni per fogli di calcolo limitano il numero di righe che possono elaborare. Verifica i limiti del sistema di destinazione prima di eseguire esportazioni di grandi dimensioni in produzione.
Esegui un test prima di automatizzare
Esegui manualmente ogni tipo di report prima di pianificare esportazioni ricorrenti. Ciò consente di individuare tempestivamente i parametri mancanti o errati, prima che causino errori silenziosi in un Flusso di lavoro automatizzato.
FAQ
L'API include uno strumento di pianificazione integrato?
No. L'API restituisce i dati su richiesta. Devi configurare nel tuo sistema qualsiasi Automazione ricorrente (giornaliera, settimanale o mensile).
Perché il link per il download scade dopo 1 ora?
La scadenza breve è una misura di sicurezza per proteggere i tuoi dati. Assicurati che il tuo Flusso di lavoro scarichi il file immediatamente dopo una risposta API riuscita.
In quale formato vengono forniti i file esportati?
Tutte le esportazioni vengono fornite come file CSV.
Posso utilizzare l'API Statistiche senza l'Add-on Statistiche+?
No. Statistiche+ è obbligatorio. Contatta il nostro Team Successo del cliente per discutere le opzioni disponibili. Puoi anche richiedere una Prova per esplorare l'Add-on.
I dati di cui ho bisogno non compaiono nell'esportazione. Cosa devo controllare?
Innanzitutto, verifica che l'Add-on Statistiche+ sia attivo su Il mio conto. Quindi controlla l'intervallo di date, il fuso orario e gli eventuali filtri facoltativi consultando la documentazione dell'API Statistiche.
Posso filtrare le esportazioni per Utente o Team?
La maggior parte dei report supporta filtri facoltativi. Consulta la documentazione dell'API Statistiche per conoscere i parametri disponibili per ciascun report.
Esiste un limite di righe per le esportazioni?
L'API non impone alcun limite di righe. Tieni presente che lo Strumento di destinazione potrebbe avere propri limiti di importazione.