GET /calltracking/settings

Возвращает текущие настройки трекинга звонков.

Формат запроса

GET https://apiauto.ru/1.0/calltracking/settings

Заголовки запроса

Заголовок

Описание

x-dealer-id

Идентификатор клиента. Используется для работы под учетной записью агентства.

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
  "settings": {
    "calltracking_enabled": {boolean},
    "offers_stat_enabled": {boolean},
    "unique_call_period": {
      "days": {integer}
    },
    "target_call_duration": {
      "seconds": {integer}
    }
  },
  "error": {string},
  "status": {string},
  "detailed_error": {string}
}

settings

Текущие настройки.


calltracking_enabled

Признак трекинга звонков.

Допустимые значения:
  • true — трекинг включен;
  • false — трекинг выключен.

offers_stat_enabled

Признак привязки звонков к объявлениям.

Допустимые значения:
  • true — звонки привязываются к объявлениям;
  • false — звонки не привязываются к объявлениям.

unique_call_period

Период, в течение которого звонок считается уникальным.


days

Количество дней.


target_call_duration

Минимальная длительность целевого звонка в секундах.


seconds

Количество секунд.


error

Код ошибки.


status

Статус запроса.

Допустимые значения:
  • SUCCESS — успешный запрос;
  • ERROR — ошибка.

detailed_error

Детальное описание ошибки.


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/calltracking/settings' \ 
-H 'x-dealer-id: 2dtrer432...' \
-H 'x-session-id: 112_aoR02Tpv...'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 24 Jul 2018 15:19:41 GMT
Content-Type: application/json
Connection: keep-alive

{
  "settings": {
    "calltracking_enabled": true,
    "offers_stat_enabled": true,
    "unique_call_period": {
      "days": 0
    },
    "target_call_duration": {
      "seconds": 0
    }
  },
  "status": "SUCCESS"
}
Предыдущая
Следующая