SurveyRespondentsExport

/api/v1/lead_ads/survey_forms/<survey_id>/respondents.xlsx

A resource that allows you to retrieve the collected data of respondents who completed the survey. Currently, export is available only in the xlsx file format.

GET

Request example

GET /api/v1/lead_ads/survey_forms/17/respondents.xlsx

Filters

• _created_at — date and time when the respondent’s answer was received. Available constraints: lte (less than or equal), gte (greater than or equal).

/api/v1/lead_ads/survey_forms/17/respondents.xlsx?_created_at__lte=2022-01-01%2000:00:00
/api/v1/lead_ads/survey_forms/17/respondents.xlsx?_created_at__gte=2022-01-01%2000:00:00

• _ad_plan_id — ad campaign IDs

/api/v1/lead_ads/survey_forms/17/respondents.xlsx?_ad_plan_id__in=6617841,6711647

• _ad_group_id — ad group IDs

/api/v1/lead_ads/survey_forms/17/respondents.xlsx?_ad_group_id__in=6617841,6711647

• _banner_id — ad (banner) IDs

/api/v1/lead_ads/survey_forms/17/respondents.xlsx?_banner_id__in=6617841,6711647

Possible response codes

• 200 — ad saved
• 404 — survey not found