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

Ловец лидов

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/lead-hunter/leads?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/lead-hunter/leads?key=1234567890qwerty&project=12345
    

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

GET /project/lead-hunter/leads

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

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

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

GET https://cloud.roistat.com/api/v1/project/lead-hunter/leads?project=12345

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

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

{
    "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 нет