Список лидов

  1. HTTP-запрос
  2. Query-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
  4. Пример

Возвращает список лидов. Также поддерживается метод POST. Чтобы получить список лидов в формате CSV, используйте эндпоинт /v2/leads/list/csv.

HTTP-запрос

GET /v2/leads/list\
?apiKey={string}\
&counter={string}\
&dimensions={array}\
&filter={string}\
&itemsPerPage={integer}\
&page={integer}\
&isShowInterActionChain={integer}

Query-параметры

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика.

dimensions *

array

Имя параметра, значение которого будет выдано в результатах.

filter

string

Правила фильтрации результатов поиска.

itemsPerPage

integer

Число результатов на страницу.

page

integer

Порядковый номер страницы ответа.

isShowInterActionChain

integer

Показвать цепочку взаимодействия лида.

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика.

dimensions *

array

Имя параметра, значение которого будет выдано в результатах.

filter

string

Правила фильтрации результатов поиска.

itemsPerPage

integer

Число результатов на страницу.

page

integer

Порядковый номер страницы ответа.

isShowInterActionChain

integer

Показвать цепочку взаимодействия лида.

Ответы

Код 200

Список лидов.

{
  "nextLink": string,
  "result": [
    {
      "analyticsClientId": string,
      "browser": string,
      "browserVersion": string,
      "callPage": string,
      "city": string,
      "compositeKeyword": string,
      "compositeSource": string,
      "compositeSourceType": string,
      "country": string,
      "createdAt": string,
      "customDimension1": string,
      "customDimension2": string,
      "customDimension3": string,
      "customDimension4": string,
      "customDimension5": string,
      "deviceName": string,
      "deviceType": string,
      "district": string,
      "entryPoint": string,
      "externalUserId": string,
      "gClid": string,
      "id": integer,
      "interActionChain": [
        string
      ],
      "ip": string,
      "lDomain": string,
      "label": string,
      "leadCreateDate": string,
      "leadId": string,
      "leadLogFormId": string,
      "leadLogFormName": string,
      "leadSourceName": string,
      "leadSourcePageId": string,
      "leadSourcePageName": string,
      "metrikaClientId": string,
      "name": string,
      "outPoint": string,
      "phone": string,
      "platformDescription": string,
      "rDomain": string,
      "rTerm": string,
      "referrer": string,
      "region": string,
      "socialNetworkType": string,
      "source": string,
      "status": string,
      "tags": [
        string
      ],
      "transferCounterId": string,
      "updatedAt": string,
      "userAgent": string,
      "utmCampaign": string,
      "utmContent": string,
      "utmMedium": string,
      "utmSource": string,
      "utmTerm": string,
      "yClid": string
    }
  ],
  "totalResults": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

nextLink

string

Ссылка на следующую страницу результатов.

result[]

array

Статистика по лидам.

result[].analyticsClientId

string

Версия браузера.

result[].browser

string

Браузер.

result[].browserVersion

string

Версия браузера.

result[].callPage

string

Страница звонка.

result[].city

string

Город - на основе IP.

result[].compositeKeyword

string

Ключевое слово.

result[].compositeSource

string

Источник.

result[].compositeSourceType

string

Тип трафика.

result[].country

string

Страна - на основе IP.

result[].createdAt

string

Дата создания.

result[].customDimension1

string

Пользовательское измерение 1.

result[].customDimension2

string

Пользовательское измерение 2.

result[].customDimension3

string

Пользовательское измерение 3.

result[].customDimension4

string

Пользовательское измерение 4.

result[].customDimension5

string

Пользовательское измерение 5.

result[].deviceName

string

Название устройства.

result[].deviceType

string

Тип устройства.

result[].district

string

Округ - на основе IP.

result[].entryPoint

string

Страница входа.

result[].externalUserId

string

Внешний идентификатор пользователя.

result[].gClid

string

Метка gclid.

result[].id

integer

Внутренний идентификатор лида.

result[].interActionChain[]

array

Цепочка взаимодействия с лидом.

result[].ip

string

IP адрес пользователя.

result[].lDomain

string

Домен страницы входа.

result[].label

string

Параметр label.

result[].leadCreateDate

string

Дата создания лида.

result[].leadId

string

Внешний идентификатор лида.

result[].leadLogFormId

string

Идентификатор формы.

result[].leadLogFormName

string

Название формы.

result[].leadSourceName

string

Название lead source.

result[].leadSourcePageId

string

Идентификатор страницы.

result[].leadSourcePageName

string

Имя страницы.

result[].metrikaClientId

string

Yandex metrika client id.

result[].name

string

Название подключения.

result[].outPoint

string

Страница выхода.

result[].phone

string

Номер телефона.

result[].platformDescription

string

Операционная система.

result[].rDomain

string

Домен реферера.

result[].rTerm

string

Поисковый запрос.

result[].referrer

string

Рефер.

result[].region

string

Регион - на основе IP.

result[].socialNetworkType

string

Социальная сеть.

result[].source

string

Источник.

result[].status

string

Статус.

result[].tags[] *

array

Список тегов.

result[].transferCounterId

string

Идентификатор счетчика, в котором был зафиксирован звонок.

result[].updatedAt

string

Дата последнего обновления.

result[].userAgent

string

UserAgent пользователя.

result[].utmCampaign

string

Метка utm_campaign.

result[].utmContent

string

Метка utm_content.

result[].utmMedium

string

Метка utm_medium.

result[].utmSource

string

Метка utm_source.

result[].utmTerm

string

Метка utm_term.

result[].yClid

string

Метка yclid.

totalResults

integer

Всего лидов по заданому фильтру.

nextLink

string

Ссылка на следующую страницу результатов.

result[]

array

Статистика по лидам.

result[].analyticsClientId

string

Версия браузера.

result[].browser

string

Браузер.

result[].browserVersion

string

Версия браузера.

result[].callPage

string

Страница звонка.

result[].city

string

Город - на основе IP.

result[].compositeKeyword

string

Ключевое слово.

result[].compositeSource

string

Источник.

result[].compositeSourceType

string

Тип трафика.

result[].country

string

Страна - на основе IP.

result[].createdAt

string

Дата создания.

result[].customDimension1

string

Пользовательское измерение 1.

result[].customDimension2

string

Пользовательское измерение 2.

result[].customDimension3

string

Пользовательское измерение 3.

result[].customDimension4

string

Пользовательское измерение 4.

result[].customDimension5

string

Пользовательское измерение 5.

result[].deviceName

string

Название устройства.

result[].deviceType

string

Тип устройства.

result[].district

string

Округ - на основе IP.

result[].entryPoint

string

Страница входа.

result[].externalUserId

string

Внешний идентификатор пользователя.

result[].gClid

string

Метка gclid.

result[].id

integer

Внутренний идентификатор лида.

result[].interActionChain[]

array

Цепочка взаимодействия с лидом.

result[].ip

string

IP адрес пользователя.

result[].lDomain

string

Домен страницы входа.

result[].label

string

Параметр label.

result[].leadCreateDate

string

Дата создания лида.

result[].leadId

string

Внешний идентификатор лида.

result[].leadLogFormId

string

Идентификатор формы.

result[].leadLogFormName

string

Название формы.

result[].leadSourceName

string

Название lead source.

result[].leadSourcePageId

string

Идентификатор страницы.

result[].leadSourcePageName

string

Имя страницы.

result[].metrikaClientId

string

Yandex metrika client id.

result[].name

string

Название подключения.

result[].outPoint

string

Страница выхода.

result[].phone

string

Номер телефона.

result[].platformDescription

string

Операционная система.

result[].rDomain

string

Домен реферера.

result[].rTerm

string

Поисковый запрос.

result[].referrer

string

Рефер.

result[].region

string

Регион - на основе IP.

result[].socialNetworkType

string

Социальная сеть.

result[].source

string

Источник.

result[].status

string

Статус.

result[].tags[] *

array

Список тегов.

result[].transferCounterId

string

Идентификатор счетчика, в котором был зафиксирован звонок.

result[].updatedAt

string

Дата последнего обновления.

result[].userAgent

string

UserAgent пользователя.

result[].utmCampaign

string

Метка utm_campaign.

result[].utmContent

string

Метка utm_content.

result[].utmMedium

string

Метка utm_medium.

result[].utmSource

string

Метка utm_source.

result[].utmTerm

string

Метка utm_term.

result[].yClid

string

Метка yclid.

totalResults

integer

Всего лидов по заданому фильтру.

Код 400

Ошибка в запросе.

{
  "error": string,
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

error

string

Код ошибки.

message

string

Описание ошибки.

error

string

Код ошибки.

message

string

Описание ошибки.

Код 403

Неверный ApiKey или нет доступа к счетчику.

{
  "error": string,
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

error

string

Код ошибки.

message

string

Описание ошибки.

error

string

Код ошибки.

message

string

Описание ошибки.

Пример

Responses:

{
  "result": [
    {
      "createdAt": "2019-04-02T16:37:31+0300",
      "id": 1,
      "leadCreateDate": "2018-12-28T19:20:24+0300",
      "leadLogFormId": "1671431442904804",
      "leadSourceName": "test",
      "source": "lead.source.social.network",
      "updatedAt": "2019-02-05T10:19:22+0300"
    }
  ],
  "totalResults": 78
}
Скопировано