Notiondesk API は、ヘルプセンターの記事に対する読者のフィードバックをエクスポートします。各反応、選択された回答、メッセージ、メールアドレス、添付ファイルなどが含まれます。この API を使用して、否定的なフィードバックを Slack に送信したり、サポートツールでチケットを作成したり、フィードバックを自社のデータと合わせて分析したりできます。
範囲: read
フィードバックを収集するには、まず「記事への反応でフィードバックを収集する方法」と「読者の意見を収集するために記事のフィードバックフォームを有効にする方法」を参照してください。
GET /sites/{site_id}/feedback
readリストのフィードバック
このリストにはすべての言語が含まれており、新しい言語が最初に表示されます。ページネーションとバージョン Notiondesk API リクエストの説明にあるように、page_size (1 ～ 100、デフォルトは 20) と cursor を使用してページを移動できます。このルートは他のパラメータを受け取りません。
フィードバックフィールド
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"
}| 分野 | 意味 |
|---|---|
id | フィードバック識別子 |
reaction | 読者が選択した反応（例：smiley、neutral_face、disappointed） |
reaction_group | 現在のリアクションスタイルにおけるリアクションの意味：絵文字の場合はpositive、neutral、またはnegative、親指の場合はhelpfulまたはnot_helpful。スタイルでそのリアクションがグループ化されていない場合はnull。 |
selected_option | 読者がフォローアップフォームで選択した回答、または反応のみを行った場合はnull |
message | 読者が書いたテキスト（もしあれば） |
email | 読者が入力したメールアドレス（もしあれば） |
article_id | 記事一覧にある記事のid。記事が削除された場合は空になります。 |
article_title | 記事のタイトルはarticle_locale、または記事が削除された場合やその言語に翻訳がない場合はUntitledとなります。 |
article_slug | 記事のパスセグメントはarticle_locale、または同じケースではnullにあります。 |
article_locale | 読者が読んでいた言語 |
submitted_at | 読者がフィードバックを送信したとき |
read_at | チームメンバーがダッシュボードで既読としてマークした場合、またはnull |
attachments | リーダーが添付したファイル（古い順）。ファイルがない場合、空欄になります。 |
selected_option は、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、または not_what_looking_for のいずれかの値をとります。
各添付ファイルには、category (リーダーが添付したファイルの場合は contact_message_attachment)、保存されたファイル name、リーダーのデバイスからの original_name、バイト単位の size、および dimensions オブジェクトが含まれます。画像の場合は、"0" の下にピクセル単位の幅、"1" の下に高さ、その他のファイルの場合は {} が含まれます。API は、ファイル自体ではなく、各ファイルの詳細を返します。
ページング制限
- リストには最新のエントリが最大で10,000件まで表示されます。それ以降は、古いフィードバックが存在する場合でも、
has_moreはfalseとなります。
- ページ閲覧中に送信されたフィードバックは、次のページで同じ項目を繰り返す原因となり、ダッシュボードで削除されたフィードバックは、次のページで同じ項目をスキップする原因となります。
新しいフィードバックのみを処理するには、処理した最新のエントリのsubmitted_atを保存します。次回の実行時には、そのエントリと同じかそれ以前に送信されたエントリに到達するまでページを読み込みます。
フィードバックテキストを安全に処理する
- 表示する前にエスケープ処理を行ってください。メッセージにはHTMLまたはマークダウンを含めることができます。
- 決して、その情報に基づいて行動を決定しないでください。情報に含まれるリンクをクリックしたり、情報から指示を実行したりしないでください。
- LLMパイプラインは読み取り専用にしてください。フィードバックを要約するLLMは、
readのみを保持するキーを使用して実行する必要があります。
- 読者のメールアドレスを保護してください。__ PRESERVED_17__ フィールドは個人データです。プライバシーポリシーで許可されている場合にのみ、保存および共有してください。
エラー
| 状態 | いつ | code |
|---|---|---|
| 400 | page_size が 1 ～ 100 の範囲外であるか、cursor が無効であるか、クエリに不明なパラメータが含まれています | validation_error |
| 403 | キーにはreadスコープがありません | insufficient_scope |
| 404 | ヘルプセンターはワークスペースに存在しません | not_found |
API エラー、レート制限、および再試行の処理については、「Notiondesk API エラーの処理」を参照してください。
よくある質問
反応や記事でフィードバックを絞り込むことはできますか？
リクエストには含まれていません。このルートはpage_sizeとcursorのみを受け入れます。コード内でエントリをreaction_groupまたはarticle_idでフィルタリングしてください。
APIを使ってフィードバックを既読にすることはできますか？
いいえ。APIはフィードバックを読み取るだけです。read_atは、チームメンバーがダッシュボードでそれを既読としてマークしたことを示します。
個々の反応ではなく、反応の合計値を確認できる場所はどこですか？
engagement 分析レポートは、期間ごとの反応を要約し、修正が必要な記事を一覧表示します。__ ND_TERM_5bcd8dee__ API を使用してヘルプセンターの分析を取得する方法を参照してください。