Получить проксилиды за указанный период¶
GET /project/proxy-leads
С помощью данного метода можно получить проксилиды за период.
Подробнее о механизме и особенностях проксирования можно прочитать в инструкции.
curl 'https://cloud.roistat.com/api/v1/project/proxy-leads?project=12345&period=2021-07-07-2021-09-24'
--request GET
--header 'Content-type: application/json'
--header 'Api-key: {KEY}'
Строка запроса:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
project | string | Номер проекта | да |
period | string | Временной период в формате YYYY-MM-DD-YYYY-MM-DD | да |
Тело запроса:
Без параметров.
Параметр | Тип | Описание |
---|---|---|
ProxyLeads | array[object] | |
> id | string | ID лида в Roistat |
> title | string | заголовок лида |
> text | string | детальное описание лида |
> name | string | имя клиента |
> phone | string | номер телефона клиента |
string | адрес электронной почты клиента | |
> roistat | string | номер визита |
> creation_date | string | дата создания лида в UTC0 |
> order_id | string | номер сделки из внешней системы |
> order_fields | object | Дополнительные поля заявки, передаваемые в CRM |
>> field_name | string | Название поля и его значение |
status | string |
Получить список дублей проксилидов за указанный период¶
GET /project/proxy-leads/duplicates
С помощью данного метода можно получить список дублей проксилидов за период.
Подробнее о механизме и особенностях проксирования можно прочитать в инструкции.
curl 'https://cloud.roistat.com/api/v1/project/proxy-leads/duplicates?project=12345&period=2021-07-07-2021-09-24'
--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": "2021-07-07 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": "2021-07-12 14:10:20",
"order_id": "12345",
"order_fields": {
"cost_field_id": "100"
}
}
],
"status": "success"
}
Строка запроса:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
project | string | Номер проекта | да |
period | string | Временной период в формате YYYY-MM-DD-YYYY-MM-DD | да |
Тело запроса:
Без параметров.
Параметр | Тип | Описание |
---|---|---|
ProxyLeads | array[object] | |
> id | string | ID лида в Roistat |
> title | string | заголовок лида |
> text | string | детальное описание лида |
> name | string | имя клиента |
> phone | string | номер телефона клиента |
string | адрес электронной почты клиента | |
> roistat | string | номер визита |
> creation_date | string | дата создания лида в UTC0 |
> order_id | string | номер сделки из внешней системы |
> order_fields | object | Дополнительные поля заявки, передаваемые в CRM |
>> field_name | string | Название поля и его значение |
status | string |
Получить информацию о конкретном проксилиде по его ID в Roistat¶
GET /project/proxy-leads/{proxyLeadId}
С помощью данного метода можно получать информацию о конкретном проксилиде по его ID в Roistat.
Подробнее о механизме и особенностях проксирования можно прочитать в инструкции.
curl 'https://cloud.roistat.com/api/v1/project/proxy-leads/{proxyLeadId}?project=12345'
--request GET
--header 'Content-type: application/json'
--header 'Api-key: {KEY}'
{
"ProxyLead": {
"id": "2",
"title": "Лид с формы заказать звонок",
"text": "Прошу перезвонить",
"name": "Питер Пен",
"phone": "71234567890",
"email": "peter@yandex.ru",
"roistat": "1000",
"creation_date": "2016-07-12 14:51:39",
"order_id": "12346"
},
"status": "success"
}
Строка запроса:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
project | string | Номер проекта | да |
Тело запроса:
Без параметров.
Параметр | Тип | Описание |
---|---|---|
ProxyLead | object | |
> id | string | ID лида в Roistat |
> title | string | заголовок лида |
> text | string | детальное описание лида |
> name | string | имя клиента |
> phone | string | номер телефона клиента |
string | адрес электронной почты клиента | |
> roistat | string | номер визита |
> creation_date | string | дата создания лида в UTC0 |
> order_id | string | номер сделки из внешней системы |
status | string |