POST /calltracking/aggregated

Возвращает статистику звонков дилера с разбиением по дням.

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

POST https://apiauto.ru/1.0/calltracking/aggregated

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

Заголовок

Описание

x-dealer-id

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

x-session-id

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

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

{
  "filter": {
    "period": {
      "from": {string},
      "to": {string}
    },
    "targets": {string},
    "results": {string},
    "callbacks": {string},
    "unique": {string},
    "caller_phones": {
      "raw": {string}
    },
    "callee_phones": {
      "raw": {string}
    },
    "category": [
      {string}
    ],
    "section": [
      {string}
    ],
    "offer_id": [
      {string}
    ],
    "vin_code": [
      {string}
    ],
    "year": {
      "from": {integer},
      "to": {integer}
    },
    "price": {
      "from": {integer},
      "to": {integer}
    },
    "cars_filter": [
      {
        "mark": {string},
        "model": {string},
        "super_gen": {string}
      }
    ],
    "body_type": [
      {string}
    ],
    "transmission": [
      {string}
    ],
    "tags": [
      {string}
    ]
  }
}

filter

Параметры фильтрации.

period

Время звонка.

from

Время звонка, от (включительно). Например, 2020-06-23T16:43:48.526Z.

to

Время звонка, до (включительно). Например, 2020-06-23T18:43:48.526Z.

targets

Фильтр по целевым звонкам.

Допустимые значения:
  • ALL_TARGET_GROUP — все звонки;
  • NONTARGET_GROUP — нецелевые звонки;
  • TARGET_GROUP — только целевые звонки.

results

Фильтр по результату звонка.

Допустимые значения:
  • ALL_RESULT_GROUP — звонки с любым результатом;
  • ANSWERED_GROUP — только принятые звонки;
  • MISSED_GROUP — только пропущенные звонки.

callbacks

Фильтр по обратным звонкам.

Допустимые значения:
  • ALL_SOURCE_GROUP — все звонки;
  • DIRECT_GROUP — только прямые звонки;
  • CALLBACK_GROUP — только обратные звонки.

unique

Фильтр по уникальным звонкам.

Допустимые значения:
  • ALL_UNIQUE_GROUP — все звонки;
  • ONLY_UNIQUE — только уникальные звонки;
  • ONLY_NON_UNIQUE — только неуникальные звонки.

caller_phones

Номер звонящего абонента.

raw

Телефонный номер в формате E.164. Например, +79999999999.

callee_phones

Номер вызываемого абонента.

raw

Телефонный номер в формате E.164. Например, +79999999999.

category

Категория транспортного средства (ТС).

Допустимые значения:
  • CARS — легковой автомобиль;
  • MOTO — мототранспорт;
  • TRUCKS — коммерческий транспорт.

section

Состояние ТС. Параметр актуален только для легковых автомобилей.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

offer_id

Идентификатор объявления.

vin_code

VIN-номер ТС.

year

Год выпуска ТС.

from

Значение от, включительно.

to

Значение до, включительно.

price

Цена, в рублях.

from

Значение от, включительно.

to

Значение до, включительно.

cars_filter

Информация о ТС по каталогу. Список марок, моделей, поколений с идентификаторами можно получить с помощью операции GET /search/cars/breadcrumbs.

mark

Марка.

model

Модель.

super_gen

Поколение.

body_type

Тип кузова автомобиля. Параметр актуален только для легковых автомобилей. Список допустимых значений смотрите в Справочнике типов кузова.

transmission

Тип коробки передач. Параметр актуален только для легковых автомобилей.

Допустимые значения:
  • MECHANICAL — механическая коробка;
  • AUTOMATIC — автоматическая коробка;
  • ROBOT — коробка-робот;
  • VARIATOR — коробка-вариатор.

tags

Массив тегов.

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

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

{
  "calls_by_day": [
    {
      "day": {string},
      "succeed_calls_amount": {integer},
      "failed_calls_amount": {integer}
    }
  ],
  "total": {
    "succeed_calls_amount": {integer},
    "failed_calls_amount": {integer}
  },
  "request": {
    "filter": {
      "period": {
        "from": {string},
        "to": {string}
      },
      "targets": {string},
      "results": {string},
      "callbacks": {string},
      "unique": {string},
      "caller_phones": {
        "raw": {string}
      },
      "callee_phones": {
        "raw": {string}
      },
      "category": [
        {string}
      ],
      "section": [
        {string}
      ],
      "offer_id": [
        {string}
      ],
      "vin_code": [
        {string}
      ],
      "year": {
        "from": {integer},
        "to": {integer}
      },
      "price": {
        "from": {integer},
        "to": {integer}
      },
      "cars_filter": [
        {
          "mark": {string},
          "model": {string},
          "super_gen": {string}
        }
      ],
      "body_type": [
        {string}
      ],
      "transmission": [
        {string}
      ],
      "tags": [
        {string}
      ]
    }
  },
  "error": {string},
  "status": {string},
  "detailed_error": {string}
}

calls_by_day

Количество звонков по дням.

day

День, за который подсчитаны звонки.

succeed_calls_amount

Количество успешных звонков за день.

failed_calls_amount

Количество проблемных звонков за день.

total

Суммарное количество звонков.

succeed_calls_amount

Суммарное количество успешных звонков.

failed_calls_amount

Суммарное количество проблемных звонков.

request

Входящий запрос.

filter

Параметры фильтрации.

period

Время звонка.

from

Время звонка, от (включительно). Например, 2020-06-23T16:43:48.526Z.

to

Время звонка, до (включительно). Например, 2020-06-23T18:43:48.526Z.

targets

Фильтр по целевым звонкам.

Допустимые значения:
  • ALL_TARGET_GROUP — все звонки;
  • NONTARGET_GROUP — нецелевые звонки;
  • TARGET_GROUP — только целевые звонки.

results

Фильтр по результату звонка.

Допустимые значения:
  • ALL_RESULT_GROUP — звонки с любым результатом;
  • ANSWERED_GROUP — только принятые звонки;
  • MISSED_GROUP — только пропущенные звонки.

callbacks

Фильтр по обратным звонкам.

Допустимые значения:
  • ALL_SOURCE_GROUP — все звонки;
  • DIRECT_GROUP — только прямые звонки;
  • CALLBACK_GROUP — только обратные звонки.

unique

Фильтр по уникальным звонкам.

Допустимые значения:
  • ALL_UNIQUE_GROUP — все звонки;
  • ONLY_UNIQUE — только уникальные звонки;
  • ONLY_NON_UNIQUE — только неуникальные звонки.

caller_phones

Номер звонящего абонента.

raw

Телефонный номер в формате E.164. Например, +79999999999.

callee_phones

Номер вызываемого абонента.

raw

Телефонный номер в формате E.164. Например, +79999999999.

category

Категория транспортного средства (ТС).

Допустимые значения:
  • CARS — легковой автомобиль;
  • MOTO — мототранспорт;
  • TRUCKS — коммерческий транспорт.

section

Состояние ТС. Параметр актуален только для легковых автомобилей.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

offer_id

Идентификатор объявления.

vin_code

VIN-номер ТС.

year

Год выпуска ТС.

from

Значение от, включительно.

to

Значение до, включительно.

price

Цена, в рублях.

from

Значение от, включительно.

to

Значение до, включительно.

cars_filter

Информация о ТС по каталогу. Список марок, моделей, поколений с идентификаторами можно получить с помощью операции GET /search/cars/breadcrumbs.

mark

Марка.

model

Модель.

super_gen

Поколение.

body_type

Тип кузова автомобиля. Параметр актуален только для легковых автомобилей. Список допустимых значений смотрите в Справочнике типов кузова.

transmission

Тип коробки передач. Параметр актуален только для легковых автомобилей.

Допустимые значения:
  • MECHANICAL — механическая коробка;
  • AUTOMATIC — автоматическая коробка;
  • ROBOT — коробка-робот;
  • VARIATOR — коробка-вариатор.

tags

Массив тегов.

error

Код ошибки.

status

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

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

detailed_error

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

Коды ответа

Код

Причина

Описание

200

OK

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

400

BAD_REQUEST

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

401

NO_AUTH

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

500

INTERNAL SERVER ERROR

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

Пример

Запрос:

curl -i -X POST 'https://apiauto.ru/1.0/calltracking/aggregated' \ 
-H 'x-dealer-id: 2dtrer432...' \
-H 'x-session-id: 112_aoR02Tpv...' \
-H 'Accept: application/json' \
-d '{
      "filter": {
        "period": {
          "from": {string},
          "to": {string}
        },
        "targets": {string},
        "results": {string},
        "callbacks": {string},
        "unique": {string},
        "caller_phones": {
          "raw": {string}
        },
        "callee_phones": {
          "raw": {string}
        },
        "category": [
          {string}
        ],
        "section": [
          {string}
        ],
        "offer_id": [
          {string}
        ],
        "vin_code": [
          {string}
        ],
        "year": {
          "from": {integer},
          "to": {integer}
        },
        "price": {
          "from": {integer},
          "to": {integer}
        },
        "cars_filter": [
          {
            "mark": {string},
            "model": {string},
            "super_gen": {string}
          }
        ],
        "body_type": [
          {string}
        ],
        "transmission": [
          {string}
        ],
        "tags": [
          {string}
        ]
      }
    }'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 24 Jul 2018 15:19:41 GMT
Content-Type: application/json
Connection: keep-alive
                    
{
  "calls_by_day": [
    {
      "day": "2020-06-23T16:43:48.526Z",
      "succeed_calls_amount": 0,
      "failed_calls_amount": 0
    }
  ],
  "total": {
    "succeed_calls_amount": 0,
    "failed_calls_amount": 0
  },
  "request": {
    "filter": {
      "period": {
        "from": "2020-06-23T16:43:48.526Z",
        "to": "2020-06-23T16:43:48.526Z"
      },
      "targets": "ALL_TARGET_GROUP",
      "results": "ALL_RESULT_GROUP",
      "callbacks": "ALL_SOURCE_GROUP",
      "unique": "ALL_UNIQUE_GROUP",
      "caller_phones": {
        "raw": "string"
      },
      "callee_phones": {
        "raw": "string"
      },
      "category": [
        "CARS"
      ],
      "section": [
        "USED"
      ],
      "offer_id": [
        "string"
      ],
      "vin_code": [
        "string"
      ],
      "year": {
        "from": 0,
        "to": 0
      },
      "price": {
        "from": 0,
        "to": 0
      },
      "cars_filter": [
        {
          "mark": "string",
          "model": "string",
          "super_gen": "string"
        }
      ],
      "body_type": [
        "string"
      ],
      "transmission": [
        "string"
      ],
      "tags": [
        "string"
      ]
    }
  },
  "status": "SUCCESS"
}
Предыдущая
POST /calltracking
Следующая
POST /calltracking/call/record