Данные о всех звонках пользователя
Данный метод позволяет получить информацию о всех звонках по всем кампаниям пользователя. Данные о звонках передаются от соответствующих операторов.Внимание: метод возвращает максимум по 500 записей на страницу.
URL: GET app.call-tracking.by/crm_api/v1/stats/raw_calls.json
Обязательные параметры:
- user_token - Секретный ключ пользователя.
- start_date - Дата начала запрашиваемого периода. Формат день-месяц-год. Пример: '01-07-2015'.
- end_date - Дата окончания запрашиваемого периода. Формат день-месяц-год. Пример: '31-07-2015'.
- page - Страница выборки. Необходимо для получения более 500 записей. Нумерация начинается с единицы. По умолчанию 1.
Необязательные параметры:
- adv_group_ids - Если указан, то будет предоставлена только информация о кампаниях указанных групп. Формат - строка (идентификаторы групп через запятую).
- adv_campaign_ids - Если указан, то будет предоставлена только информация о кампаниях указанных идентификаторов. Формат - строка (идентификаторы кампании через запятую).
Пример запроса:
app.call-tracking.by/crm_api/v1/stats/raw_calls.json?user_token=TsMbF1mGyiEWejBJ2eOh_w&start_date=01-07-2015&end_date=03-07-2015&page=1&adv_campaign_ids=854,855,856
var campaign_ids = [854,855,856];
requestUrl = '/crm_api/v1/stats/raw_calls.json?user_token=TsMbF1mGyiEWejBJ2eOh_w&start_date=01-07-2015&end_date=03-07-2015&adv_campaign_ids=' + campaign_ids.join(',');
$.get(requestUrl, function (data) {
$('.response-example').removeClass('loading-data');
$('.response-example').html(JSON.stringify([data[0], data[1]], null, 4))
})
Пример ответа:
Параметры ответа:
- datetime - время звонка, с таймзоной.
- campaign_id - идентификатор кампании.
- campaign_name - имя кампании.
- stat_source - нормализованный источник звонка. Сформирован на основании utm-меток, реферала и названия отслеживаемого источника.
- duration - продолжительность звонка.
- caller_number - номер звонившего.
- caller_operator - оператор звонившего (Внимание: вывод об операторе сделан на основании номера звонившего, а не его реального оператора).
- ads_number - номер кампании, который был показан клиенту и/или был размещен в рекламном объявлении.
- ads_number_redirect_phones - массив номеров, на который переадресовывает номер кампании.
- answered - статус звонка (отвечен/не отвечен).
- answered_number - номер, который ответил на звонок.
- voice_record_link - ссылка на файл записи, присутствует, если запись включена. Запись по ссылке доступна, пока запись хранится в личном кабинете (исходя из настроек хранения записей в личном кабинете клиента).
- utm_keyword - ключевое слово (в случае, если звонок поступил по динамической кампании).
- utm_source - источник трафика (в случае, если звонок поступил по динамической кампании).
- utm_campaign - рекламная кампания (в случае, если звонок поступил по динамической кампании).
- utm_medium - тип трафика (в случае, если звонок поступил по динамической кампании).
- utm_content - содержание рекламной кампании (в случае, если звонок поступил по динамической кампании).
- roistat_id - уникальный идентификатор Roistat (доступно только при использовании динамического коллтрекинга и при наличии на сайте скрипта Roistat).
- google_analytics_id - уникальный идентификатор Google Analytics (доступно только при использовании динамического коллтрекинга и при наличии на сайте скрипта Google Analytics).
- yandex_metrica_id - уникальный идентификатор Яндекс Метрики (доступно только при использовании динамического коллтрекинга и при наличии на сайте скрипта Яндекс Метрики).
Возможное практическое применение:
Для создания страниц с данными о всех звонках с фильтрацией. Например следующего вида: