LeadFormLeadsExport

/api/v1/lead_ads/lead_forms/<lead_form_id>/leads.<export_format>

A resource that allows you to retrieve the collected data of leads who have submitted the form. Currently, the following export formats are available:

• csv
• xlsx

GET

Request example

GET /api/v1/lead_ads/lead_forms/17/leads.csv

Response example

HTTP 200
"Campaign ID","Group ID","Ad ID","Lead time","Name","Phone","Do you have a pet?"
"1","3","2","2022-12-08 21:41:03.922 +0000 UTC","Victor","+78008005555","Yes"

Filters

• _created_at — lead received date and time. Available constraints: lte (less than or equal), gte (greater than or equal).

/api/v1/lead_ads/lead_forms/17/leads.csv?_created_at__lte=2022-01-01%2000:00:00
/api/v1/lead_ads/lead_forms/17/leads.csv?_created_at__gte=2022-01-01%2000:00:00

• _ad_plan_id — ad campaign IDs

/api/v1/lead_ads/lead_forms/17/leads.csv?_ad_plan_id__in=6617841,6711647

• _ad_group_id — ad group IDs

/api/v1/lead_ads/lead_forms/17/leads.csv?_ad_group_id__in=6617841,6711647

• _banner_id — ad (banner) IDs

/api/v1/lead_ads/lead_forms/17/leads.csv?_banner_id__in=6617841,6711647

Possible response codes

• 200 — ad saved
• 404 — lead form not found