Список кампаний CSAT

Метод возвращает список кампаний CSAT, которые можно использовать для опроса клиентов. Кампания — это то, что оценивает клиент. Например, работа службы поддержки или удобство оформления заказа.

Информация о кампании используется в форме получения отзыва в методе csat/create.

GET https://api.rees46.ru/csat/campaigns

Параметры

Параметр	Тип	Обязателен?	Описание
shop_id	String	Да	API-ключ

Запрос

Пример запроса:

curl "https://api.rees46.ru/csat/campaigns?shop_id=..."

Ответ

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

{
  "status": "success",
  "payload": {
    "campaigns": [
      {
        "name": "...",
        "code": "...",
        "dissatisfied_question": "...",
        "neutral_question": "...",
        "satisfied_question": "...",
        "dissatisfied_success": "...",
        "neutral_success": "...",
        "satisfied_success": "...",
        "button_label": "..."
      },
      {
        "name": "...",
        "code": "...",
        "dissatisfied_question": "...",
        "neutral_question": "...",
        "satisfied_question": "...",
        "dissatisfied_success": "...",
        "neutral_success": "...",
        "satisfied_success": "...",
        "button_label": "..."
      }
    ]
  }
}

Расшифровка свойств кампании:

Свойство	Тип	Описание
name	String	Название кампании
code	String	Уникальный код кампании
dissatisfied_question	String	Вопрос для оценки от 1 до 2
neutral_question	String	Вопрос для оценки 3
satisfied_question	String	Вопрос для оценки от 4 до 5
dissatisfied_success	String	Сообщение с благодарностью за отзыв для оценки от 1 до 2
neutral_success	String	Сообщение с благодарностью за отзыв для оценки 3
satisfied_success	String	Сообщение с благодарностью за отзыв для оценки от 4 до 5
button_label	String	Надпись на кнопке, которая показывается после отправки отзыва

Если кампаний нет, в campaigns придет пустой массив.

В случае ошибки ответ будет в формате:

{
  "status": "error",
  "payload": {
    "message": "Invalid API key"
  }
}