Получение статистики по звонкам

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

HTTP-запрос

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

Query-параметры

apiKey *	string Токен для авторизации.
counter *	string Идентификатор счетчика, с которого будет снята статистика.
dimensions *	array Массив измерений для выгрузки.
filter	string Правила фильтрации результатов поиска.
itemsPerPage	integer Число результатов в ответе.
page	integer Порядковый номер страницы ответа.

* Обязательный параметр

Ответы

Код 200

Возвращает список звонков.

{
  "nextLink": string,
  "result": [
    {
      "analyticsClientId": string,
      "areaCode": string,
      "browser": string,
      "browserVersion": string,
      "callId": string,
      "callPage": string,
      "callRecordUrl": string,
      "calledPhone": string,
      "callerPhone": string,
      "city": string,
      "compositeKeyword": string,
      "compositeSource": string,
      "compositeSourceType": string,
      "connectDuration": integer,
      "countCall": integer,
      "country": string,
      "countryCode": string,
      "customDimension1": string,
      "customDimension2": string,
      "customDimension3": string,
      "customDimension4": string,
      "customDimension5": string,
      "destination": string,
      "deviceName": string,
      "deviceType": string,
      "district": string,
      "duration": integer,
      "entryPoint": string,
      "externalUserId": string,
      "gClid": string,
      "ip": string,
      "isCallback": boolean,
      "isFirstInSeries": boolean,
      "isTarget": boolean,
      "isUnique": boolean,
      "isUniqueTarget": boolean,
      "lDomain": string,
      "label": string,
      "metrikaClientId": string,
      "outPoint": string,
      "phoneName": string,
      "platformDescription": string,
      "poolName": string,
      "rDomain": string,
      "rTerm": string,
      "region": string,
      "regionName": string,
      "sid": string,
      "startTime": string,
      "status": string,
      "statusCode": string,
      "stopTime": string,
      "tags": [
        string
      ],
      "userAgent": string,
      "utmCampaign": string,
      "utmContent": string,
      "utmMedium": string,
      "utmSource": string,
      "utmTerm": string,
      "uuid": string,
      "yClid": string
    }
  ],
  "totalResults": integer
}
Скопировано

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

Свернуть всё

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

Поля

nextLink	string Ссылка на следующую страницу результатов.
result[]	array Статистика по звонкам.
result[].analyticsClientId	string Идентификатор клиента Google Analytics.
result[].areaCode	string Код региона (для номера клиента).
result[].browser	string Браузер.
result[].browserVersion	string Версия браузера.
result[].callId	string Идентификатор звонка.
result[].callPage	string Страница звонка.
result[].callRecordUrl	string Ссылка на запись разговора.
result[].calledPhone	string Номер, на который звонили.
result[].callerPhone	string Номер клиента.
result[].city	string Город (на основе IP).
result[].compositeKeyword	string Ключевое слово.
result[].compositeSource	string Источник.
result[].compositeSourceType	string Тип трафика.
result[].connectDuration	integer Время ожидания вызова.
result[].countCall	integer Порядковый номер обращения пользователя.
result[].country	string Страна (на основе IP).
result[].countryCode	string Код страны (для номера клиента).
result[].customDimension1	string Пользовательское измерение 1.
result[].customDimension2	string Пользовательское измерение 2.
result[].customDimension3	string Пользовательское измерение 3.
result[].customDimension4	string Пользовательское измерение 4.
result[].customDimension5	string Пользовательское измерение 5.
result[].destination	string Номер, на который был перенаправлен вызов.
result[].deviceName	string Название устройства.
result[].deviceType	string Тип устройства.
result[].district	string Округ (на основе IP).
result[].duration	integer Длительность звонка, в секундах.
result[].entryPoint	string Страница входа.
result[].externalUserId	string Внешний идентификатор пользователя.
result[].gClid	string Метка gclid.
result[].ip	string Идентификатор адреса пользователя.
result[].isCallback	boolean Направление звонка (true - обратный, false - прямой).
result[].isFirstInSeries	boolean Является ли вызов уникальным.
result[].isTarget	boolean Является ли звонок целевым.
result[].isUnique	boolean Является ли звонок уникальным.
result[].isUniqueTarget	boolean Является ли звонок уникально целевым.
result[].lDomain	string Домен страницы входа.
result[].label	string Параметр label.
result[].metrikaClientId	string Идентификатор клиента в Яндекс.Метрике.
result[].outPoint	string Страница выхода.
result[].phoneName	string Название номера.
result[].platformDescription	string Операционная система.
result[].poolName	string Название пула.
result[].rDomain	string Домен реферера.
result[].rTerm	string Поисковый запрос.
result[].region	string Регион (на основе IP).
result[].regionName	string Название региона (для номера клиента).
result[].sid	string Идентификатор сеанса, связанного со звонком.
result[].startTime	string Время начала звонка.
result[].status	string Статус звонка (success - успешный, failed - не успешный).
result[].statusCode	string Код статуса звонка.
result[].stopTime	string Время окончания звонка.
result[].tags[] *	array Список тегов для звонка.
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[].uuid	string Идентификатор пользователя.
result[].yClid	string Метка yclid.
totalResults	integer Всего звонков по заданому фильтру.

nextLink	string Ссылка на следующую страницу результатов.
result[]	array Статистика по звонкам.
result[].analyticsClientId	string Идентификатор клиента Google Analytics.
result[].areaCode	string Код региона (для номера клиента).
result[].browser	string Браузер.
result[].browserVersion	string Версия браузера.
result[].callId	string Идентификатор звонка.
result[].callPage	string Страница звонка.
result[].callRecordUrl	string Ссылка на запись разговора.
result[].calledPhone	string Номер, на который звонили.
result[].callerPhone	string Номер клиента.
result[].city	string Город (на основе IP).
result[].compositeKeyword	string Ключевое слово.
result[].compositeSource	string Источник.
result[].compositeSourceType	string Тип трафика.
result[].connectDuration	integer Время ожидания вызова.
result[].countCall	integer Порядковый номер обращения пользователя.
result[].country	string Страна (на основе IP).
result[].countryCode	string Код страны (для номера клиента).
result[].customDimension1	string Пользовательское измерение 1.
result[].customDimension2	string Пользовательское измерение 2.
result[].customDimension3	string Пользовательское измерение 3.
result[].customDimension4	string Пользовательское измерение 4.
result[].customDimension5	string Пользовательское измерение 5.
result[].destination	string Номер, на который был перенаправлен вызов.
result[].deviceName	string Название устройства.
result[].deviceType	string Тип устройства.
result[].district	string Округ (на основе IP).
result[].duration	integer Длительность звонка, в секундах.
result[].entryPoint	string Страница входа.
result[].externalUserId	string Внешний идентификатор пользователя.
result[].gClid	string Метка gclid.
result[].ip	string Идентификатор адреса пользователя.
result[].isCallback	boolean Направление звонка (true - обратный, false - прямой).
result[].isFirstInSeries	boolean Является ли вызов уникальным.
result[].isTarget	boolean Является ли звонок целевым.
result[].isUnique	boolean Является ли звонок уникальным.
result[].isUniqueTarget	boolean Является ли звонок уникально целевым.
result[].lDomain	string Домен страницы входа.
result[].label	string Параметр label.
result[].metrikaClientId	string Идентификатор клиента в Яндекс.Метрике.
result[].outPoint	string Страница выхода.
result[].phoneName	string Название номера.
result[].platformDescription	string Операционная система.
result[].poolName	string Название пула.
result[].rDomain	string Домен реферера.
result[].rTerm	string Поисковый запрос.
result[].region	string Регион (на основе IP).
result[].regionName	string Название региона (для номера клиента).
result[].sid	string Идентификатор сеанса, связанного со звонком.
result[].startTime	string Время начала звонка.
result[].status	string Статус звонка (success - успешный, failed - не успешный).
result[].statusCode	string Код статуса звонка.
result[].stopTime	string Время окончания звонка.
result[].tags[] *	array Список тегов для звонка.
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[].uuid	string Идентификатор пользователя.
result[].yClid	string Метка yclid.
totalResults	integer Всего звонков по заданому фильтру.

* Обязательный параметр

Код 400

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

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

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

Свернуть всё

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

Поля

error	integer Код ошибки.
message	string Описание ошибки.

* Обязательный параметр

Пример

Responses:

{
  "result": [
    {
      "areaCode": "913",
      "callId": "82CE9B42DE603EBF.1618910989.3870345",
      "calledPhone": "74999385421",
      "callerPhone": "79132447263",
      "connectDuration": 0,
      "countCall": 1,
      "countryCode": "RU",
      "destination": "undefined",
      "duration": 0,
      "isCallback": "false",
      "isFirstInSeries": "true",
      "isTarget": "false",
      "isUnique": "true",
      "isUniqueTarget": "false",
      "poolName": "Пул",
      "startTime": "2021-04-20T12:29:49+0300",
      "status": "FAILED",
      "stopTime": "2021-04-20T12:29:49+0300",
      "uuid": "92dbbfed-d0f4-4c53-809f-97cdaae7053c"
    }
  ],
  "totalResults": 1
}
Скопировано

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