Beam Help
Richiedi supporto

How-to · Zoho DESK

Come visualizzare le analitiche dei pin in Zoho Desk

Analizza l'utilizzo degli elementi fissati e i relativi pattern di coinvolgimento.

Le analitiche dei pin in Zoho Desk possono essere recuperate in modo programmatico tramite un endpoint API dedicato che restituisce dati di coinvolgimento per gli elementi fissati. Questa guida ti accompagna nella chiamata a quell'endpoint utilizzando il client API di Zoho Desk.


Perché è importante


Se gestisci una knowledge base o un portale di supporto Zoho Desk, capire come si comportano i contenuti fissati ti aiuta a stabilire le priorità su ciò che rimane visibile ai clienti. I team che monitorano il coinvolgimento degli articoli o la produttività degli agenti spesso necessitano delle analitiche dei pin come parte di flussi di lavoro di reportistica più ampi. Questo è particolarmente utile quando si creano dashboard o si automatizza la reportistica al di fuori dell'interfaccia nativa di Zoho Desk.


Procedura passo dopo passo


Passaggio 1. Assicurati che la tua connessione OAuth di Zoho Desk sia attiva e che il tuo token di accesso sia valido. Il client API gestisce automaticamente il rinnovo del token, ma la connessione iniziale deve essere stabilita e memorizzata. Se stai utilizzando il motore Zpilot, il helper getzohoapi recupererà e aggiornerà le credenziali per tuo conto. [7]


Passaggio 2. Verifica che i tuoi scope OAuth includano le autorizzazioni necessarie per Zoho Desk. Come minimo, il tuo ambiente dovrebbe avere configurati Desk.tickets.READ, Desk.basic.READ e Desk.search.READ — questi fanno parte del blocco standard ZOHODESKSCOPES. Senza gli scope corretti, l'API rifiuterà la tua richiesta. [2]


Passaggio 3. Crea un'istanza del client ZohoDeskApi con un ZohoDeskClient valido. Avrai bisogno del dominio API, di un token di accesso corrente e del tuo ID organizzazione (orgid). Se il tuo orgid non è ancora memorizzato, il client può scoprirlo automaticamente chiamando getallorganizations e leggendo il primo risultato dall'elenco restituito. [7]


Passaggio 4. Chiama l'endpoint delle analitiche dei pin utilizzando il seguente metodo sulla tua istanza ZohoDeskApi:


result = api.get_pin_analytics(p={})

Questo invia una richiesta GET a /api/v1/doc/pinanalytics. Il parametro p accetta un dizionario opzionale di parametri di query — passa un dict vuoto se non hai filtri da applicare. [1]


Passaggio 5. Analizza la risposta. Il metodo restituisce la risposta API grezza come oggetto Python. Itera sui dati restituiti per estrarre le metriche rilevanti per le tue esigenze di reportistica. Se stai utilizzando l'interfaccia chat di Zpilot, l'assistente formatterà automaticamente i campi chiave in testo normale. [5]


Passaggio 6. Se stai eseguendo questo all'interno della suite di test del motore Zpilot, puoi testare l'endpoint tramite la classe DeskTestRunner. Inizializza il runner con il tuo org_id e un livello di rischio "SAFE", chiama setup() per stabilire la connessione, quindi invoca direttamente il metodo delle analitiche. [8]


Problemi comuni


  • ID organizzazione mancante: Se org_id è vuoto o non è persistito nel record di connessione, il client Desk potrebbe fallire silenziosamente o restituire un errore di autorizzazione. Verifica sempre che l'ID organizzazione sia popolato prima di effettuare le chiamate. [7]
  • Token scaduti: Il refresher del token interroga il database per ottenere il refreshtoken più recente e aggiorna l'accesstoken memorizzato in caso di successo. Se il rinnovo stesso fallisce — ad esempio a causa di un client secret revocato — il refresher restituisce None e le successive chiamate API falliranno. [7]
  • Scope mancanti: La configurazione ZOHODESKSCOPES non include uno scope dedicato alle analitiche per nome. Se Zoho aggiunge l'applicazione degli scope per le analitiche dei pin in una futura versione dell'API, potrebbe essere necessario aggiungerlo alla configurazione del tuo file .env. [2]
  • Conflitti di porta: Se stai eseguendo il server Zpilot in locale, deve essere in esecuzione sulla porta 8080. L'utilizzo di qualsiasi altra porta interrompe l'URI di reindirizzamento OAuth e impedisce completamente l'acquisizione del token. [6]

Cosa verificare


  • Verifica che il tuo orgid sia memorizzato nel record del database zohoconnections prima di chiamare l'endpoint — un ID organizzazione mancante è la causa più comune di errori silenziosi. [7]
  • Conferma gli scope OAuth nel tuo file .env includano almeno Desk.basic.READ e Desk.search.READ per garantire che l'API Desk accetti le tue richieste. [2]
  • Ispeziona la risposta grezza di getpinanalytics per verificare la presenza di una chiave data attesa o di una struttura a lista prima di costruire qualsiasi logica di reportistica a valle. [1]

---


*Beam Help è un servizio di supporto esperto indipendente per Zoho — non siamo il supporto ufficiale Zoho, e questa guida si basa sul comportamento dell'API osservato nella documentazione REST API di Zoho Desk e nelle implementazioni client.*

Sources cited

  1. [1] GET /api/v1/_doc/__pin_analytics
  2. [2] config.py
  3. [3] README.md
  4. [4] server.py: chat_plan
  5. [5] planner.py
  6. [6] server.py: get_zoho_api
  7. [7] desk_test_runner.py