L'API Notiondesk esporta i feedback lasciati dai lettori sugli articoli del tuo centro assistenza: ogni reazione, la risposta di approfondimento selezionata, il messaggio, l'indirizzo email e i file allegati. Usala per inviare feedback negativi a Slack, creare ticket nel tuo strumento di supporto o analizzare i feedback insieme ai tuoi dati.
Ambito: read
Per iniziare a raccogliere feedback, consulta Come raccogliere feedback con le reazioni agli articoli e Abilitare il modulo di feedback sugli articoli per raccogliere informazioni dai lettori .
GET /sites/{site_id}/feedback
readElenco dei feedback
L'elenco comprende tutte le lingue, dalla più recente alla meno recente. È possibile sfogliarlo utilizzando page_size (da 1 a 100, predefinito 20) e cursor, come descritto in Paginazione e nelle richieste API della versione Notiondesk . Il percorso non accetta altri parametri.
Campi di feedback
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/feedback?page_size=50" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"id": "8b1f6c0e-3d4a-4f2b-9c7e-5a1d2e3f4b60",
"email": "[email protected]",
"message": "The steps skip the login screen.",
"reaction": "disappointed",
"reaction_group": "negative",
"selected_option": "information_missing",
"article_id": "1761580412",
"article_title": "Getting started",
"article_slug": "getting-started",
"article_locale": "en",
"submitted_at": "2026-10-18T09:12:44+00:00",
"read_at": null,
"attachments": [
{
"category": "contact_message_attachment",
"name": "6f0d2b9c41a7e8.png",
"dimensions": {"0": 1280, "1": 720},
"original_name": "login-screen.png",
"size": 48213
}
]
}
],
"has_more": true,
"next_cursor": "OPAQUE_CURSOR"
}| Campo | Senso |
|---|---|
id | L'identificatore di feedback |
reaction | La reazione scelta dal lettore, ad esempio smiley, neutral_face o disappointed |
reaction_group | Cosa significa la reazione secondo il tuo stile di reazione attuale: positive, neutral o negative per le emoji, helpful o not_helpful per i pollici. null quando lo stile non raggruppa quella reazione |
selected_option | La risposta che il lettore ha scelto nel modulo di follow-up, o null quando ha reagito soltanto |
message | Il testo scritto dal lettore, se presente |
email | L'indirizzo email inserito dal lettore, se presente |
article_id | Il campo id dell'articolo, come nell'elenco degli articoli . Vuoto quando l'articolo è stato eliminato. |
article_title | Il titolo dell'articolo in article_locale, oppure in Untitled quando l'articolo è stato eliminato o non ha una traduzione in quella lingua |
article_slug | Il segmento del percorso dell'articolo in article_locale o null negli stessi casi |
article_locale | La lingua che il lettore stava leggendo |
submitted_at | Quando il lettore ha inviato il feedback |
read_at | Quando un membro del team lo ha contrassegnato come letto nella dashboard, o null |
attachments | I file allegati dal lettore, dal più vecchio al più recente. Vuoto quando non ce ne sono |
selected_option assume uno dei seguenti valori: content_accurate_up_to_date, easy_to_find, clear_and_easy_to_understand, worked_as_expected, something_else, information_missing, information_incorrect, hard_to_understand o not_what_looking_for.
Ogni allegato ha un category (contact_message_attachment per un file allegato da un lettore), il file memorizzato name, il original_name dal dispositivo del lettore, il size in byte e l'oggetto dimensions: per un'immagine, la larghezza in pixel sotto "0" e l'altezza sotto "1", e {} per qualsiasi altro file. L'API restituisce i dettagli di ciascun file, non il file stesso.
Limiti di paginazione
- L'elenco raggiunge al massimo le 10.000 voci più recenti. Oltre tale soglia,
has_morediventafalseanche in presenza di feedback più vecchi.
- Il feedback inviato durante la navigazione nella pagina può far sì che la pagina successiva ripeta una voce, mentre il feedback eliminato nella dashboard può far sì che ne venga saltata una.
Per elaborare solo i nuovi feedback, memorizza il submitted_at dell'ultima voce gestita. Alla successiva esecuzione, leggi le pagine fino a raggiungere una voce inviata in posizione uguale o precedente.
Gestisci il testo di feedback in modo sicuro
- Esegui l'escape prima di visualizzare il messaggio. Un messaggio può contenere HTML o Markdown.
- Non lasciare mai che influenzi le tue azioni. Non seguire i link al suo interno né eseguire le istruzioni che vi sono contenute.
- Mantenere le pipeline LLM in sola lettura. Un LLM che riassume il feedback dovrebbe essere eseguito con una chiave che contiene solo
read.
- Proteggi le email dei lettori. Il campo
emailcontiene dati personali. Archivialo e condividilo solo laddove la tua informativa sulla privacy lo consenta.
Errori
| Stato | Quando | code |
|---|---|---|
| 400 | page_size è al di fuori dell'intervallo da 1 a 100, cursor non è valido oppure la query ha un parametro sconosciuto | validation_error |
| 403 | La chiave non ha l'ambito read | insufficient_scope |
| 404 | Il centro assistenza non è presente nel tuo spazio di lavoro | not_found |
Vedi Errori API, limiti di frequenza e tentativi di invio dell'handle Notiondesk .
Domande frequenti
Posso filtrare i commenti per reazione o per articolo?
Non nella richiesta. Il percorso accetta solo page_size e cursor. Filtra le voci nel tuo codice, in base a reaction_group o article_id.
Posso contrassegnare il feedback come letto tramite API?
No. L'API legge solo i feedback. read_at indica quando un membro del team ha contrassegnato il messaggio come letto nella dashboard.
Dove posso visualizzare il totale delle reazioni anziché le singole voci?
Il report di analisi engagement riassume le reazioni per periodo ed elenca gli articoli da rivedere. Vedi Ottenere analisi del centro assistenza con l'API Notiondesk .