Дополнительные данные отчетов

Получайте дополнительные данные отчётов: файлы, текстовые ответы и публичные ссылки

Дополнительные данные отчётов

Помимо стандартных агрегированных показателей, WebAsk позволяет получить дополнительную детализацию по отчётам: файлы, загруженные респондентами, и текстовые ответы по отдельным виджетам.

Эти эндпоинты используют UUID публичного отчёта и идентификаторы виджетов внутри него. Это удобно, если вы хотите встроить отчёт в свою систему, но при этом иногда забирать «сырые» вложения или тексты.

Краткий обзор эндпоинтов

HTTP	Endpoint	Назначение
GET	/quiz/{id}/report/{report_uuid}/files	Получить файлы виджета отчёта (тип "file")
GET	/quiz/{id}/report/{report_uuid}/inputs	Получить текстовые ответы виджета отчёта

Файлы виджетов отчёта

Эндпоинт GET /quiz/{id}/report/{report_uuid}/files возвращает список файлов, прикреплённых к виджету типа file в отчёте.

В ответе для каждого файла вы получите поля url, name и ext.

Параметры пути

id — ID опроса.
report_uuid — UUID публичного отчёта.

Query‑параметры

Параметр	Тип	Описание
widget_id	string	UUID вопроса (question_uuid виджета в отчёте).
widget_hash	string	UUID версии виджета (widget_hash в shared_report_widgets).
limit	integer	Количество записей (по умолчанию 50).
offset	integer	Смещение (по умолчанию 0).

Текстовые ответы виджетов

Эндпоинт GET /quiz/{id}/report/{report_uuid}/inputs возвращает текстовые ответы по виджетам типа input, email, phone и т.п.

Query-параметры

Параметр	Тип	По умолчанию	Описание
widget_id	UUID	—	Фильтр по ID виджета
widget_hash	UUID	—	Фильтр по хешу версии виджета
limit	integer	50	Максимальное число записей
offset	integer	0	Смещение для пагинации

GET /api/v3/service/quiz/{id}/report/{report_uuid}/inputs

curl -X GET "https://api.webask.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"

Публичные ссылки на отчёты

Эндпоинты для генерации публичных ссылок на различные представления отчёта. Ссылки не требуют авторизации для просмотра.

Публичная ссылка на сводку POST /api/v3/service/quiz/{id}/shared/summary

Генерирует публичную ссылку на сводку ответов за указанный период.

Параметр	Тип	Описание
date_from	string	Дата начала периода (Y-m-d)
date_to	string	Дата окончания периода (Y-m-d)

POST /api/v3/service/quiz/{id}/shared/summary

curl -X POST "https://api.webask.io/api/v3/service/quiz/123/shared/summary" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "date_from": "2024-01-01", "date_to": "2024-01-31" }'

Пример ответа:

{ "url": "https://app.webask.io/shared/summary/abc123token" }

Публичная ссылка на отчёт POST /api/v3/service/quiz/{id}/shared/report

Генерирует публичную ссылку на полный отчёт по опросу. Тело запроса не требуется.

POST /api/v3/service/quiz/{id}/shared/report

curl -X POST "https://api.webask.io/api/v3/service/quiz/123/shared/report" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Пример ответа:

{ "report": "https://app.webask.io/shared/report/xyz789token" }

Публичная ссылка на ответы POST /api/v3/service/quiz/{id}/shared/answers

Генерирует публичную ссылку на список ответов с применёнными фильтрами.

Параметр	Тип	Описание
answerIds[]	array	Список ID ответов для включения
type	string	`full`, `in`, `not_in`, `answer`
date_from	string	Начало периода (Y-m-d)
date_to	string	Конец периода (Y-m-d)
timezone	string	Часовой пояс (например, `Europe/Moscow`)
is_complete	boolean	Только завершённые ответы

POST /api/v3/service/quiz/{id}/shared/answers

curl -X POST "https://api.webask.io/api/v3/service/quiz/123/shared/answers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "full",
    "date_from": "2024-01-01",
    "date_to": "2024-01-31",
    "timezone": "Europe/Moscow",
    "is_complete": true
  }'

Пример ответа:

{ "url": "https://app.webask.io/shared/answers/def456token" }

Предыдущий раздел

Следующий раздел