fetch_survey_responses
Fetch individual survey responses (paginated, newest first) with each answer. 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. PRIVACY: include_metadata adds PII (IP address, user agent, device) — keep it false unless the user explicitly needs it, and NEVER copy that metadata into notes, tickets or any other field. ParticipantToken is null when no contact info was collected. For aggregated results use fetch_survey_report; for unlimited export point the user to the Export CSV button in the app. DISPLAY RULE: never show ResponseToken/ParticipantToken UUIDs.
fetch_survey_responses
When to use
Fetch individual survey responses (paginated, newest first) with each answer. 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. PRIVACY: include_metadata adds PII (IP address, user agent, device) — keep it false unless the user explicitly needs it, and NEVER copy that metadata into notes, tickets or any other field. ParticipantToken is null when no contact info was collected. For aggregated results use fetch_survey_report; for unlimited export point the user to the Export CSV button in the app. DISPLAY RULE: never show ResponseToken/ParticipantToken UUIDs.
Parameters to validate before calling
survey_token(string, required) — The survey token (UUID v4). Get it via fetch_surveyscompleted(boolean, optional) — true = completed only, false = abandoned only, omit = both (optional)from_date(string, optional) — Inclusive start date YYYY-MM-DD (optional)to_date(string, optional) — Inclusive end date YYYY-MM-DD, covers the whole day (optional)include_metadata(boolean, optional) — Include device/browser/IP metadata — PII, default false. Only set true if the user explicitly needs itpage(number, optional) — range: 1–+∞ — Page number (optional, default 1)limit(number, optional) — range: 1–100 — Results per page (optional, default 25, max 100)
Notes
include_metadataadds PII (IP address, user agent, device) — keep it false unless the user explicitly needs itNEVER copy response metadata into notes, tickets or any other field
For unlimited export point the user to the Export CSV button in the app
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (optional, default 1) | |
| limit | No | Results per page (optional, default 25, max 100) | |
| to_date | No | Inclusive end date YYYY-MM-DD, covers the whole day (optional) | |
| completed | No | true = completed only, false = abandoned only, omit = both (optional) | |
| from_date | No | Inclusive start date YYYY-MM-DD (optional) | |
| survey_token | Yes | The survey token (UUID v4). Get it via fetch_surveys | |
| include_metadata | No | Include device/browser/IP metadata — PII, default false. Only set true if the user explicitly needs it |