Relatórios extras
Obtenha dados de relatórios adicionais: uploads de arquivos, respostas de texto e links públicos
Dados adicionais de relatórios
Além das métricas agregadas padrão, o SurveyNinja permite recuperar detalhes extras dos relatórios: arquivos enviados pelos entrevistados e respostas de texto para widgets individuais.
Esses endpoints utilizam o UUID público do relatório e os identificadores de widgets contidos nele. Isso é conveniente quando você deseja incorporar um relatório em seu sistema, mas ocasionalmente precisa obter anexos "brutos" ou respostas de texto.
Visão geral dos endpoints
| HTTP | Endpoint | Finalidade |
|---|---|---|
| GET | /quiz/{id}/report/{report_uuid}/files | Obter arquivos de widgets do relatório (tipo "file") |
| GET | /quiz/{id}/report/{report_uuid}/inputs | Obter respostas de texto para um widget de relatório |
Arquivos de widgets do relatório
O endpoint GET /quiz/{id}/report/{report_uuid}/files retorna a lista de arquivos anexados a um widget do tipo file no relatório.
A resposta inclui os campos url, name e ext para cada arquivo.
Parâmetros de caminho
id— ID da pesquisa.report_uuid— UUID público do relatório.
Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| widget_id | string | UUID da pergunta (question_uuid do widget no relatório). |
| widget_hash | string | UUID da versão do widget (widget_hash em shared_report_widgets). |
| limit | integer | Número de registros (padrão: 50). |
| offset | integer | Deslocamento (padrão: 0). |
Respostas de texto de widgets
O endpoint GET /quiz/{id}/report/{report_uuid}/inputs retorna respostas de texto para widgets do tipo input, email, phone, etc.
Parâmetros de consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
| widget_id | UUID | — | Filtrar por ID do widget |
| widget_hash | UUID | — | Filtrar por hash da versão do widget |
| limit | integer | 50 | Número máximo de registros |
| offset | integer | 0 | Deslocamento para paginação |
curl -X GET "https://api.surveyninja.io/api/v3/service/quiz/123/report/abc-report-uuid/inputs?limit=50&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"