Leads

/api/v1/lead_ads/leads.json

A resource that allows you to retrieve a list of received leads.

GET

Retrieve the list of leads.

Request example

GET /api/v1/lead_ads/leads.json

Response example

{
  "count": 3,
  "offset": 0,
  "limit": 0,
  "items": [
    {
      "id": 2523,
      "form_name": "New lead form 2022-07-15 17:53"
      ...
    },
    {
      "id": 105,
      "form_name": "New lead form 2022-08-16 19:49"
      ...
    },
    {
      "id": 42303,
      "form_name": "New lead form 2022-08-16 19:51"
      ...
    }
  ]
}

Available fields are described in LeadsListElement.

The resource supports pagination via the limit and offset parameters.

• limit — number of leads in the response. Default is 20. Maximum is 50.

/api/v1/lead_ads/leads.json?limit=10

• offset — offset by N leads from the beginning of the current result set.

/api/v1/lead_ads/leads.json?limit=5&offset=15

Filters

• _form_ids — lead form IDs

/api/v1/lead_ads/leads.json?_form_ids__in=6617841,6711647

• _ad_plan_ids — ad campaign IDs

/api/v1/lead_ads/leads.json?_ad_plan_ids__in=6617841,6711647

• _ad_group_ids — ad group IDs

/api/v1/lead_ads/leads.json?_ad_group_ids__in=6617841,6711647

• _banner_ids — ad (banner) IDs

/api/v1/lead_ads/leads.json?_banner_ids__in=6617841,6711647

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

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

Sorting

• id

/api/v1/lead_ads/leads.json?sorting=id   - ascending
/api/v1/lead_ads/leads.json?sorting=-id  - descending

• form_id

/api/v1/lead_ads/leads.json?sorting=form_id   - ascending
/api/v1/lead_ads/leads.json?sorting=-form_id  - descending

• form_name

/api/v1/lead_ads/leads.json?sorting=form_name   - ascending
/api/v1/lead_ads/leads.json?sorting=-form_name  - descending

• ad_plan_id

/api/v1/lead_ads/leads.json?sorting=ad_plan_id   - ascending
/api/v1/lead_ads/leads.json?sorting=-ad_plan_id  - descending

• ad_group_id

/api/v1/lead_ads/leads.json?sorting=ad_group_id   - ascending
/api/v1/lead_ads/leads.json?sorting=-ad_group_id  - descending

• banner_id

/api/v1/lead_ads/leads.json?sorting=banner_id   - ascending
/api/v1/lead_ads/leads.json?sorting=-banner_id  - descending

• created_at

/api/v1/lead_ads/leads.json?sorting=created_at   - ascending
/api/v1/lead_ads/leads.json?sorting=-created_at  - descending

• multiple fields

/api/v1/lead_ads/leads.json?sorting=created_at,form_name,-id