Ottieni analisi del centro assistenza con l'API Notiondesk

L'API Notiondesk ti fornisce i dati statistici relativi alle pagine del tuo centro assistenza: visitatori, visualizzazioni degli articoli, tempo trascorso sulla pagina, paesi, termini di ricerca utilizzati dai lettori, ricerche che non producono risultati e reazioni dei lettori ai tuoi articoli. Utilizzala per alimentare uno strumento di business intelligence, pubblicare un report settimanale su Slack o individuare i contenuti che i tuoi lettori non riescono a trovare.

GET /sites/{site_id}/analytics/{report}

Ogni report necessita dell'ambito read. Per leggere questi numeri nella dashboard, consulta Come migliorare il tuo centro assistenza con i feedback dei lettori .

Ricevi un riepilogo di 30 giorni

quick copre gli ultimi 30 giorni fino ad oggi e non accetta parametri di query. articles conta ogni articolo del centro assistenza, bozze incluse. reactions conta l'ultima reazione di ogni lettore per articolo.

Ottieni un report per un intervallo di date

overview, search e engagement accettano un intervallo di date e una dimensione del bucket:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/quick" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "articles": 42,
  "visitors": 25,
  "searches": 9,
  "reactions": 4
}

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/search?start_date=2026-09-01T00:00:00Z&end_date=2026-10-01T00:00:00Z&date_scale=week&timezone=Europe/Paris" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Regole per il poligono di tiro:

• Le date utilizzano il formato YYYY-MM-DDTHH:MM[:SS] con un offset opzionale. Senza un offset, la data viene letta come UTC, non in timezone. Scrivi + come %2B nell'URL oppure usa Z.

• Il periodo inizia a partire dal 1° gennaio 2020 e termina al massimo tra due giorni.

• Al massimo 1.000 secchi. Ad esempio, minute copre al massimo 16 ore e hour al massimo 41 giorni. Utilizzare un valore più ampio, date_scale, per intervalli più lunghi.

• La settimana inizia di lunedì.

Ogni report confronta il tuo intervallo con il periodo di pari durata immediatamente precedente: previous e total_previous descrivono tale periodo precedente.

serie di conteggio

visitors, article_views e searches condividono la stessa forma:

{
  "total": 12,
  "total_previous": 8,
  "difference": 4,
  "percentage_difference": 50.0,
  "current": [{"date": "2026-09-14", "count": 7}, {"date": "2026-09-15", "count": 5}],
  "previous": [{"date": "2026-08-20", "count": 8}]
}

• current e previous elencano solo i bucket che contengono dati, dal più vecchio al più recente.

• Il date di un secchio è quando inizia, in timezone: YYYY-MM-DD per day e più grossolano, YYYY-MM-DDTHH:MM per hour e minute.

• percentage_difference è 0.0 quando il totale precedente è 0.

overview

search

{
  "searches_without_results": {
    "total": 3,
    "total_previous": 0,
    "difference": 3,
    "percentage_difference": 0.0,
    "queries": [{"query": "refund policy", "searches": 3}]
  }
}

Nota: questo è il tuo backlog di contenuti: ogni query è una domanda posta dai lettori a cui il tuo centro assistenza non è stato in grado di rispondere. searches_without_results.queries

engagement

Un reaction_summary segue il tuo stile di reazione:

score va da 0 a 100: la percentuale di reazioni positive, con una reazione neutra che conta la metà sotto emoji. Con lo stile thumbs, i gruppi sono helpful e not_helpful. Vedi Come raccogliere feedback con le reazioni agli articoli .

Elenco delle dimensioni

{
  "style": "emoji",
  "total": 6,
  "score": 58,
  "groups": [
    {"key": "positive", "count": 3, "percent": 50},
    {"key": "neutral", "count": 1, "percent": 17},
    {"key": "negative", "count": 2, "percent": 33}
  ]
}

• Gli elenchi di query top_articles, top_referrers, article_engagements e articles_to_revise possono contenere fino a 50 righe ciascuno e coprono solo il periodo corrente. Un elenco di 50 righe potrebbe essere incompleto: restringi l'intervallo per visualizzare tutte le righe.

• I totali comprendono tutto, non solo le righe elencate.

title, , , , e provengono dai browser dei visitatori e chiunque può falsificarli. Bloccali prima di visualizzarli e non seguirli o agire in base ad essi senza averli controllati.urlhostpathnamereferrerquery

Analisi e il tuo piano

L'accesso alle API richiede un piano Enterprise, che include analisi avanzate, pertanto ogni report accetta qualsiasi intervallo e scala entro 1.000 bucket.

Limite di velocità

Oltre alle 120 letture al minuto della tua chiave, i report di analisi vengono conteggiati rispetto a un budget di 30 richieste al minuto per centro assistenza , condiviso da ogni chiave e app OAuth del tuo spazio di lavoro. Una richiesta tramite essa risponde con 429 rate_limited e la sua intestazione Retry-After indica quando riprovare. Memorizza i report nella cache invece di richiederli a ogni caricamento della pagina.

Errori

Vedi Errori API, limiti di frequenza e tentativi di invio dell'handle Notiondesk .

Domande frequenti

Cosa succederà dopo?

• Esporta il feedback dei lettori con l'API Notiondesk

• Automatizza le attività comuni del centro assistenza con l'API Notiondesk

• Gestire gli errori dell'API Notiondesk, i limiti di frequenza e i tentativi di ripetizione.