Перейти к содержанию

Ловец лидов

Получить лиды Ловца лидов

GET /project/lead-hunter/leads

С помощью данного метода можно получить проксилиды за указанный период.

Подробнее о механизме и особенностях проксирования можно прочитать в инструкции.

curl 'https://cloud.roistat.com/api/v1/project/lead-hunter/leads?project=12345' \
    --request GET \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'
{
    "ProxyLeads": [
        {
            "id": "2",
            "title": "Лид с формы заказать звонок",
            "text": "Прошу перезвонить",
            "name": "Питер Пен",
            "phone": "71234567890",
            "email": "peter@yandex.ru",
            "roistat": "1000",
            "creation_date": "2016-07-12 14:51:39",
            "order_id": "12346",
            "order_fields": {
                "cost_field_id": "200"
            }
        },
        {
            "id": "1",
            "title": "Лид с формы заказать звонок",
            "text": "",
            "name": "Алиса",
            "phone": "79998887766",
            "email": "alice@yandex.ru",
            "roistat": "1001",
            "creation_date": "2016-07-12 14:10:20",
            "order_id": "12345",
            "order_fields": {
                "cost_field_id": "100"
            }
        }
    ],
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без параметров.

Параметр Тип Описание
ProxyLeads array[object]
id string ID лида в Roistat
title string заголовок лида
text string детальное описание лида
name string имя клиента
phone string номер телефона клиента
email string адрес электронной почты клиента
roistat string номер визита
creation_date string дата создания лида в UTC0
order_id string номер сделки из внешней системы
order_fields object Дополнительные поля заявки, передаваемые в CRM
>> field_name string Название поля и его значение
status string