Eksportuj opinie czytelników za pomocą interfejsu API Notiondesk

API Notiondesk eksportuje opinie czytelników dotyczące artykułów w Twoim centrum pomocy: każdą reakcję, wybraną odpowiedź uzupełniającą, wiadomość, adres e-mail oraz załączone pliki. Użyj go do wysyłania negatywnych opinii do Slacka, tworzenia zgłoszeń w narzędziu wsparcia lub analizowania opinii w zestawieniu z własnymi danymi.

Zakres: read

Aby w pierwszej kolejności zebrać opinie, zapoznaj się z tematami Jak zbierać opinie za pomocą reakcji na artykuły i Włączanie formularza opinii o artykule w celu zbierania spostrzeżeń czytelników .

GET /sites/{site_id}/feedback

Użyj klucza, który zawiera tylko zakres. Wiadomości z opiniami, e-maile i załączniki są pisane przez czytelników, więc traktuj je jako niewiarygodne dane wejściowe. Jeśli LLM przetworzy ten tekst za pomocą klucza, który również może pisać, tekst może nakłonić go do wprowadzenia zmiany w centrum pomocy.read

Lista opinii

Lista obejmuje wszystkie języki, od najnowszych na początku. Przejrzyj ją za pomocą page_size (od 1 do 100, domyślnie 20) i cursor, zgodnie z opisem w sekcji Paginate i w wersji Notiondesk API Requests . Trasa nie przyjmuje żadnych innych parametrów.

Pola opinii

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"
}

selected_option przyjmuje jedną z następujących wartości: 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 lub not_what_looking_for.

Każdy załącznik zawiera category (contact_message_attachment dla pliku dołączonego przez czytelnika), zapisany plik name, original_name z urządzenia czytelnika, size w bajtach oraz obiekt dimensions: w przypadku obrazu szerokość w pikselach pod "0" i wysokość pod "1", a także {} dla dowolnego innego pliku. Interfejs API zwraca szczegóły każdego pliku, a nie sam plik.

Limity stronicowania

• Lista obejmuje maksymalnie 10 000 najnowszych wpisów. Powyżej has_more oznacza false, nawet jeśli istnieją starsze opinie.

• Przesłanie opinii na Twojej stronie może spowodować, że na następnej stronie zostanie powtórzony jeden wpis, a usunięcie opinii w panelu może spowodować pominięcie jednego wpisu.

Aby przetworzyć tylko nowe opinie, zapisz submitted_at najnowszego wpisu, który obsłużono. Przy następnym uruchomieniu czytaj strony, aż natrafisz na wpis przesłany w tym samym momencie lub wcześniej.

Bezpiecznie obchodź się z tekstem opinii

• Przed wyświetleniem należy go wyłączyć. Wiadomość może zawierać kod HTML lub znacznik Markdown.

• Nigdy nie pozwól, aby to ono decydowało o działaniu. Nie klikaj w linki w nim zawarte ani nie wykonuj instrukcji z niego zawartych.

• Utrzymuj potoki LLM w trybie tylko do odczytu. LLM, który podsumowuje informacje zwrotne, powinien działać z kluczem zawierającym tylko read.

• Chroń e-maile czytelników. Pole email zawiera dane osobowe. Przechowuj je i udostępniaj tylko w zakresie dozwolonym przez Twoją politykę prywatności.

Błędy

Zobacz Obsługa błędów API Notiondesk, limitów szybkości i ponownych prób .

Często zadawane pytania

Co dalej?

• Zautomatyzuj typowe zadania centrum pomocy za pomocą interfejsu API Notiondesk

• Uzyskaj analizę centrum pomocy za pomocą interfejsu API Notiondesk

• Uwierzytelnij się za pomocą interfejsu API Notiondesk, używając kluczy API