De Notiondesk API exporteert de feedback die lezers achterlaten op uw helpcentrumartikelen: elke reactie, het vervolgantwoord dat ze hebben gekozen, hun bericht, hun e-mailadres en de bijgevoegde bestanden. Gebruik deze API om negatieve feedback naar Slack te sturen, tickets aan te maken in uw supporttool of feedback te analyseren naast uw eigen gegevens.
Bereik: __GEVESTIGD_73__
Om feedback te verzamelen, raadpleeg je Hoe je feedback verzamelt met reacties op artikelen en Schakel het feedbackformulier voor artikelen in om lezersinzichten te verzamelen .
GET /sites/{site_id}/feedback
readLijst met feedback
De lijst bevat alle talen, van nieuwste naar minst nieuwste. Blader erdoorheen met page_size (1 tot 100, standaard 20) en cursor, zoals beschreven in Paginate en versie Notiondesk API-verzoeken . De route accepteert geen andere parameters.
Feedbackvelden
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"
}| Veld | Betekenis |
|---|---|
id | De feedback-identificatie |
reaction | De reactie die de lezer heeft gekozen, zoals smiley, neutral_face of disappointed |
reaction_group | Wat de reactie betekent onder je huidige reactiestijl: positive, neutral of negative voor emoji, helpful of not_helpful voor duimen. null wanneer de stijl die reactie niet groepeert. |
selected_option | Het antwoord dat de lezer koos in het vervolgformulier, of __GESERVEERD_56__ wanneer ze alleen reageerden |
message | De tekst die de lezer heeft geschreven, indien van toepassing. |
email | Het e-mailadres dat de lezer heeft ingevoerd, indien van toepassing. |
article_id | De id van het artikel, zoals in de artikellijst . Leeg wanneer het artikel is verwijderd. |
article_title | De titel van het artikel in article_locale, of Untitled wanneer het artikel is verwijderd of geen vertaling in die taal heeft. |
article_slug | Het padsegment van het artikel in article_locale, of null in dezelfde gevallen |
article_locale | De taal die de lezer aan het lezen was |
submitted_at | Toen de lezer de feedback verstuurde |
read_at | Wanneer een teamlid het als gelezen heeft gemarkeerd in het dashboard, of null |
attachments | De bestanden die de lezer heeft bijgevoegd, worden weergegeven als oudste, eerst de oudste. Leeg als er geen bestanden zijn. |
selected_option neemt een van de volgende waarden aan: 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 of not_what_looking_for.
Elke bijlage heeft een category (contact_message_attachment voor een bestand dat door een lezer is bijgevoegd), het opgeslagen bestand name, de original_name van het apparaat van de lezer, de size in bytes en het dimensions-object: voor een afbeelding de breedte in pixels onder "0" en de hoogte onder "1", en {} voor elk ander bestand. De API retourneert de details van elk bestand, niet het bestand zelf.
Pagineringslimieten
- De lijst bevat maximaal de 10.000 nieuwste vermeldingen. Daarna wordt
has_morefalse, zelfs als er oudere feedback beschikbaar is.
- Feedback die tijdens het bekijken van de pagina wordt gegeven, kan ervoor zorgen dat één item op de volgende pagina wordt herhaald, en feedback die in het dashboard wordt verwijderd, kan ervoor zorgen dat één item wordt overgeslagen.
Om alleen nieuwe feedback te verwerken, slaat u de submitted_at van de meest recente inzending die u hebt verwerkt op. Lees bij de volgende keer dat u het programma uitvoert de pagina's totdat u een inzending tegenkomt die op of vóór deze waarde is ingediend.
Ga veilig om met feedbackteksten.
- Ontsnap aan de uitvoer voordat je het weergeeft. Een bericht kan HTML of Markdown bevatten.
- Laat het nooit een beslissing over je nemen. Klik niet op links erin en voer geen instructies uit die erin staan.
- Houd LLM-pipelines alleen-lezen. Een LLM die feedback samenvat, moet worden uitgevoerd met een sleutel die alleen
readbevat.
- Bescherm de e-mailadressen van lezers. Het veld
emailbevat persoonsgegevens. Bewaar en deel deze gegevens alleen waar uw privacybeleid dit toestaat.
Fouten
| Status | Wanneer | code |
|---|---|---|
| 400 | page_size ligt buiten het bereik van 1 tot 100, cursor is ongeldig, of de query bevat een onbekende parameter. | validation_error |
| 403 | De sleutel mist het bereik read | insufficient_scope |
| 404 | Het helpcentrum bestaat niet in uw werkruimte. | not_found |
Zie Foutmeldingen, snelheidslimieten en herhaalpogingen van de Notiondesk API afhandelen .
Veelgestelde vragen
Kan ik feedback filteren op reactie of artikel?
Niet in het verzoek. De route accepteert alleen page_size en cursor. Filter de resultaten in je code op reaction_group of article_id.
Kan ik feedback als gelezen markeren met de API?
Nee. De API leest alleen feedback. read_at geeft aan wanneer een teamlid het als gelezen heeft gemarkeerd in het dashboard.
Waar kan ik de totale reacties zien in plaats van de individuele vermeldingen?
Het analyseverslag engagement vat de reacties per periode samen en geeft een lijst van de artikelen die herzien moeten worden. Zie Analysegegevens van het helpcentrum verkrijgen met de Notiondesk API .