fetch_survey_report
Fetch the aggregated report of a survey: visit/start/complete totals, completion rate and times, device and browser breakdown, daily timeline, and per-question answer distributions. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. Distributions are capped at 25 buckets — the long tail counts toward TotalAnswers but does not travel (Truncated flag). A survey with no traffic returns the full structure with zeros — report that honestly, never invent activity. CompletionRate = Completes/Visits as an integer percentage; CompletionTimes are in seconds. For raw individual responses use fetch_survey_responses.
fetch_survey_report
When to use
Fetch the aggregated report of a survey: visit/start/complete totals, completion rate and times, device and browser breakdown, daily timeline, and per-question answer distributions. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. Distributions are capped at 25 buckets — the long tail counts toward TotalAnswers but does not travel (Truncated flag). A survey with no traffic returns the full structure with zeros — report that honestly, never invent activity. CompletionRate = Completes/Visits as an integer percentage; CompletionTimes are in seconds. For raw individual responses use fetch_survey_responses.
Parameters to validate before calling
survey_token(string, required) — The survey token (UUID v4). Get it via fetch_surveystimeline_days(number, optional) — range: 1–365 — Days back for the daily timeline (optional, default 30, max 365)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| survey_token | Yes | The survey token (UUID v4). Get it via fetch_surveys | |
| timeline_days | No | Days back for the daily timeline (optional, default 30, max 365) |