Формы на сайте

GET /api/partners/campaign-form-leads/

🔒 bot-key или OAuth

Кратко: Получить список заполненных форм на сайте.

Параметры запроса:

• limit (integer, опциональный) — кол-во элементов на странице (макс. 100)

• offset (integer, опциональный) — кол-во элементов для пропуска

• form_uuid (uuid, опциональный) — фильтр по UUID формы

• chat_uuid (uuid, опциональный) — фильтр по UUID чата

• platform (string, опциональный) — фильтр по платформе: Telegram, Facebook, Viber, Vkontakte, Whatsapp, Email, Widget

• created_at__gte (string, date-time, опциональный) — дата создания начало диапазона

• created_at__lte (string, date-time, опциональный) — дата создания конец диапазона

• o (string, опциональный) — сортировка: created_at (по возрастанию) или -created_at (по убыванию)

Возвращает: 200 OK — постраничный список объектов CampaignFormLead.

Пример ответа:

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "form_uuid": "7ab1c234-5678-4def-a012-3456789bcdef",
      "form_data": {
        "name": "Иван Иванов",
        "phone": "[phone]",
        "comment": "Хочу узнать подробности"
      },
      "platform": "Telegram",
      "get_params": { "utm_source": "google" },
      "utm": {
        "utm_source": "google",
        "utm_medium": "cpc",
        "utm_campaign": "summer2024"
      },
      "chat_uuid": "9bc2d345-6789-4abc-b123-456789cdef01",
      "ga_client_id": "GA1.1.1234567890.1680000000",
      "created_at": "2024-06-01T10:30:00Z",
      "scoring": 10
    }
  ]
}

Ошибки: 401 — ошибка авторизации.

Пример запроса:

# Получить лиды конкретной формы за период
curl -X GET "https://dashboard.fstrk.io/api/partners/campaign-form-leads/?form_uuid=7ab1c234-5678-4def-a012-3456789bcdef&created_at__gte=2024-06-01T00:00:00Z&created_at__lte=2024-06-30T23:59:59Z&limit=100" \
  -H "bot-key: your_bot_key"

---

GET /api/partners/campaign-form-leads/{uuid}/

🔒 bot-key или OAuth

Кратко: Получить информацию о конкретной заполненной форме по UUID.

Параметры пути:

• uuid (string, обязательный) — UUID лида

Возвращает: 200 OK — объект CampaignFormLead:

• uuid (uuid) — UUID лида

• form_uuid (uuid) — UUID формы

• form_data (object) — данные заполненной HTML-формы

• platform (string) — платформа, через которую пришёл пользователь

• get_params (object) — GET-параметры страницы в момент заполнения

• utm (object) — UTM-метки

• chat_uuid (uuid) — UUID чата, привязанного к лиду

• ga_client_id (string) — Google Analytics Client ID

• created_at (string, date-time) — дата создания

• scoring (integer) — очки за заполненную форму

Ошибки: 401 — ошибка авторизации; 404 — лид не найден.

Пример запроса:

curl -X GET https://dashboard.fstrk.io/api/partners/campaign-form-leads/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "bot-key: your_bot_key"