Импорт плановых метрик

API-метод дает возможность импортировать плановые метрики в статистику Calltouch:

Подробное описание функционала плановых метрик представлено в отдельной статье.

Важно: для успешного импорта название пользовательских столбцов и целей не должны пересекаться с названиями метрик Calltouch.

Важно: импортированные с помощью метода API плановые метрики обновятся на следующий день в отчете «Все источники — Данные площадок» и в дашбордах. В остальных отчетах (например, «Все источники — Данные Calltouch») импортированные метрики будут отображены сразу после импорта.

Запрос

POST: https://api.calltouch.ru/report-service/RestAPI/api/plans-import/add 
   

• Access-Token – API-ключ
• SiteId – ID ЛК Calltouch

Тело запроса в формате JSON:

    
  
{
"items": [
{
"dateFrom": "01-04-2021",
"dateTo": "02-04-2021",
"source": "yandex",
"medium": "cpc",
"campaign": "april",
"content": "sale",
"keyword": "распродажа",
"metric":
{
"type": "Лиды",
"name": "Уникальные лиды",
"value": 100
}
},
{
"dateFrom": "01-04-2021",
"dateTo": "20-04-2021",
"source": "google",
"medium": "cpc",
"metric":
{
"type": "Сделки и ROI",
"name": "Выручка",
"value": 23423
}
},
{
"dateFrom": "01-04-2021",
"dateTo": "20-04-2021",
"medium": "cpc",
"metric":
{
"type": "Пользовательские",
"name": "Название столбца",
"value": 22
}
}
]
}
   

Описание параметров тела запроса:

В одном запросе можно передать сразу несколько наборов планов для разных комбинаций параметров. Все наборы перечисляются внутри массива items, максимальное количество наборов - 100.

Ответ

Успешный ответ

Если API-запрос прошел валидацию и был успешно отправлен, в ответ вы получите ID лога, по которому отдельным API-запросом можно будет отследить его статус – успешно ли импортировались данные или нет. Пример ответа:

    
    
{
"meta": [],
"data": {
"importLogId": 123
}
}
   

Где 123 – ID лога, по которому можно в отдельном API-запросе узнать статус импорта.

Ошибки

Все ошибки содержат поясняющий текст в ответе с подсказкой что нужно исправить, чтобы запрос завершился успешно.

1. Ошибка авторизации

    
    
{
"message": "Access token не найден"
}
   

2. Ошибка формата тела запроса

    
    
{
"meta": [],
"data": {
"type": "apiError",
"apiErrorData": {
"errorCode": 1,
"errorMessage": "Синтаксическая ошибка JSON в запросе или запрос пустой",
"errorDescription": null
},
"validationErrorData": null
}
}
   

3. Ошибка в содержимом параметров

    
    
{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "items[0].source",
"message": "Должно быть заполнено одно или несколько из полей: source, medium, campaign, content, keyword"
},
{
"fieldPath": "items[n].metric.type",
"message": "Значение не должно быть пустым."
},
{
"fieldPath": "items[n].metric.type",
"message": "Значение не совпадает с одним из допустимых."
},
{
"fieldPath": "items",
"message": "Эта коллекция должна содержать 1 элемент или больше."
}
]
}
}
}
   

4. Ошибка даты в запросе

    
    
{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "items[0].dateTo",
"message": "Значение не является правильной датой."
},
{
"fieldPath": "items[n].dateFrom",
"message": "Значение dateFrom должно быть меньше или равно dateTo"
}
]
}
}
}
   

5. Отсутствие обязательных полей в запросе

    
    
{
"meta": [],
"data":
{
"message": "В запросе не указано обязательное поле \"dateTo\""
}
}
   

6. Неуникальное название пользовательского столбца в запросе

    
    
{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "items[0].metric.name",
"message": "Название пользовательского столбца не уникально, импорт невозможен."
}
]
}
}
}
   

API-метод для получения статуса импорта

Запрос

POST: https://api.calltouch.ru/report-service/RestAPI/api/plans-import/123/status
   

• Access-Token – API-ключ
• SiteId – ID ЛК Calltouch

Где 123 – ID лога, который был в ответе на успешный запрос на импорт плановых метрик.

Ответ

В ответе будут ранее отправленные данные в запросе на импорт плановых метрик, поверх которых добавится параметр status, в котором будут актуальные статусы отправленных ранее API-запросов.

Пример ответа:

    
    
{
"meta": [],
"data": {
"status": "success",
"items": [
{
"dateFrom": "01-04-2021",
"dateTo": "02-04-2021",
"source": "yandex",
"medium": "cpc",
"campaign": "april",
"content": "sale",
"keyword": "распродажа",
"metric":
{
"type": "Лиды",
"name": "Уникальные лиды",
"value": 100
}
},
{
"dateFrom": "01-04-2021",
"dateTo": "20-04-2021",
"source": "google",
"medium": "cpc",
"metric":
{
"type": "Сделки и ROI",
"name": "Выручка",
"value": 23423
}
},
{
"dateFrom": "01-04-2021",
"dateTo": "20-04-2021",
"medium": "cpc",
"metric":
{
"type": "Пользовательские",
"name": "Название столбца",
"value": 22
}
}
]
}
} 
   

 

Возможные значения параметра status:

Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch