Запрос¶
GET lead/[project_id]/list?offset=[offset]&limit=[limit]&sort=[sort]
Передаваемые параметры:¶
- project_id - ID проекта, в котором будет осуществлён поиск
- offset - Количество записей, которые нужно пропустить
- limit - Количество записей, которое должно вернуться
- sort - Сортировка (массив с возможными ключами: created_at, updated_at и со значениями: 3 - по убыванию, 4 - по возрастанию)
- filter - Применяемый фильтр
- is_deal - Возвращать только сделки (true) или только лиды (false)
Пример запроса¶
curl -H "token: someToken" https://direct.lptracker.ru/lead/32423/list?offset=10&limit=1&sort[updated_at]=3&filter[created_at_from]=1535529725
Пример ответа при успешном выполнении:
[ { "id": 10035871, "contact_id": 8217221, "name": "", "deal": true, "view": { "id": 105719695, "project_id": 53391, "source": "yadnex", "campaign": "test", "keyword": "Test" }, "stage_id": null, "custom": [ { "id": 946557, "name": "Дата лида", "type": "date", "value": "04.07.2018 21:12:14" }, { "id": 946558, "name": "Дата сделки", "type": "payday", "value": "25.07.18 13:13" }, { "id": 946561, "name": "Шаг воронки", "type": "funnel", "value": "953184" }, { "id": 946564, "name": "Владелец лида", "type": "owner", "value": { "id": 21712, "type": "staff" } }, { "id": 946566, "name": "Тип захвата", "type": "name", "value": "Заявка с сайта(стандартный код)" }, { "id": 946567, "name": "Источник", "type": "platform", "value": "[yadnex] test - Test" }, { "id": 946575, "name": "Количество", "type": "number", "value": "432" } ], "created_at": "04.07.2018 21:12", "contact": { "id": "contact_id", "project_id": 123, "details": [ { "id": "contact_detail_id", "type": "email/phone", "data": "email@example.com/+71234567890" } ], "fields": [ { "id": "12", "type": "string", "name": "fieldName", "value": "exampleText" } ], "created_at": "DD.MM.YY HH:MM:SS", "name": "user_name", "site": "example.com" } } ]
Важные уточнения¶
- Поля offset и limit не обязательные. По-умолчанию выдается 10 записей с начала списка
- Поле sort - ассоциативный массив
- Поле filter - ассоциативный массив фильтра поиска. Может содержать следующие поля
- created_at_from - Время создания лида от (timestamp)
- created_at_to - Время создания лида до (timestamp)
- updated_at_from - Время обновления лида от (timestamp)
- updated_at_to - Время обновления лида до (timestamp)