A API Notiondesk exporta o feedback que os leitores deixam nos artigos da sua central de ajuda: cada reação, a resposta escolhida, a mensagem, o e-mail e os arquivos anexados. Use-a para enviar feedback negativo para o Slack, criar tickets na sua ferramenta de suporte ou analisar o feedback juntamente com seus próprios dados.
Escopo: __PRESERVADO_73__
Para começar a coletar feedback, consulte Como coletar feedback com reações a artigos e Ativar formulário de feedback do artigo para coletar insights do leitor .
GET /sites/{site_id}/feedback
readFeedback da lista
A lista abrange todos os idiomas, do mais recente para o mais antigo. Navegue pelas páginas com page_size (de 1 a 100, padrão 20) e cursor, conforme descrito em Paginate e solicitações de API da versão Notiondesk . A rota não aceita nenhum outro parâmetro.
Campos de 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 | Significado |
|---|---|
id | O identificador de feedback |
reaction | A reação escolhida pelo leitor, como smiley, neutral_face ou disappointed |
reaction_group | Significado da reação de acordo com seu estilo de reação atual: positive, neutral ou negative para emojis, helpful ou not_helpful para polegares. null quando o estilo não agrupa essa reação. |
selected_option | A resposta que o leitor escolheu no formulário de acompanhamento, ou null quando ele apenas reagiu |
message | O texto que o leitor escreveu, se houver. |
email | O endereço de e-mail que o leitor inseriu, se houver. |
article_id | O campo id do artigo, conforme consta na lista de artigos . Fica vazio quando o artigo é excluído. |
article_title | O título do artigo em article_locale, ou Untitled quando o artigo foi excluído ou não possui tradução nesse idioma. |
article_slug | O segmento do caminho do artigo em article_locale, ou null nos mesmos casos. |
article_locale | A língua que o leitor estava lendo |
submitted_at | Quando o leitor enviou o feedback |
read_at | Quando um membro da equipe marcou como lido no painel, ou null |
attachments | Os arquivos anexados pelo leitor, do mais antigo para o mais recente. Vazio quando não houver nenhum. |
selected_option assume um destes valores: 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 ou not_what_looking_for.
Cada anexo possui um category (contact_message_attachment para um arquivo anexado por um leitor), o arquivo armazenado name, o original_name do dispositivo do leitor, o size em bytes e o objeto dimensions: para uma imagem, a largura em pixels em "0" e a altura em "1", e {} para qualquer outro arquivo. A API retorna os detalhes de cada arquivo, não o próprio arquivo.
Limites de paginação
- A lista atinge, no máximo, as 10.000 entradas mais recentes. Depois disso,
has_moreéfalse, mesmo quando existem comentários mais antigos.
- O feedback enviado enquanto você está na página pode fazer com que a próxima página repita uma entrada, e o feedback excluído no painel pode fazer com que uma entrada seja pulada.
Para processar apenas novos comentários, armazene o valor submitted_at da entrada mais recente que você processou. Na próxima execução, leia as páginas até encontrar uma entrada enviada no mesmo horário ou antes dele.
Gerencie textos de feedback com segurança.
- Escape o texto antes de exibi-lo. Uma mensagem pode conter HTML ou Markdown.
- Nunca deixe que ele tome decisões. Não clique em links presentes nele nem execute instruções a partir dele.
- Mantenha os pipelines LLM somente leitura. Um LLM que resume o feedback deve ser executado com uma chave que contenha apenas
read.
- Proteja os e-mails dos leitores. O campo
emailcontém dados pessoais. Armazene e compartilhe-os somente onde sua política de privacidade permitir.
Erros
| Status | Quando | code |
|---|---|---|
| 400 | page_size está fora do intervalo de 1 a 100, o cursor é inválido ou a consulta possui um parâmetro desconhecido. | validation_error |
| 403 | A chave não possui o escopo read | insufficient_scope |
| 404 | A central de ajuda não está disponível no seu espaço de trabalho. | not_found |
Consulte os erros, limites de taxa e novas tentativas da API Handle Notiondesk .
Perguntas frequentes
Posso filtrar os comentários por reação ou artigo?
Não está na requisição. A rota aceita apenas page_size e cursor. Filtre as entradas no seu código por reaction_group ou article_id.
Posso marcar um feedback como lido usando a API?
Não. A API apenas lê o feedback. read_at mostra quando um membro da equipe marcou o feedback como lido no painel.
Onde posso ver o total de reações em vez de entradas individuais?
O relatório analítico engagement resume as reações por período e lista os artigos a serem revisados. Consulte Obter análises da central de ajuda com a API Notiondesk .