/
Получение списка групп кампаний проекта

Получение списка групп кампаний проекта

Метод

GET https://api.uxfeedback.ru/{version}/private/campaigns/groups

где

  • {version} - это версия метода, которая предполагает какое-то поведение метода. Рекомендуется использовать “последнюю” или “более высокую” версию метода, как самую актуальную.

Версии метода

v1

GET https://api.uxfeedback.ru/v1/private/campaigns/groups

нет доп.параметров, отдаётся ответ в виде структуры:

{ "data": [ { "id": 975, "name": "Имя группы 1" }, ... ], "errors": [] }

v2

GET https://api.uxfeedback.ru/v2/private/campaigns/groups

Внесены изменения в версию v1:

  • добавлена возможность выгружать информацию по “опросам по ссылке”

  • появился доп.параметр kind в строке запроса и в структуре ответа

версия включает работу с доп.параметром:

  • kind - объекты для отображения в списке:

    • campaign - кампании активного фидбека

    • survey - опросы по ссылке

    • all - все, т.е кампании пассивного фидбека, кампании активного фидбека и опросы по ссылке, по умолчанию: all
      У пассивного фидбека группы не предусмотрены

Пример метода

Пример максимально полного запроса: https://api.uxfeedback.ru/v2/private/campaigns/groups?kind=all

Структура ответа

{ "data": [ { "id": 1, "name": "имя_группы", "kind": "тип_кампании" // campaign или survey }, ... ], "errors": [] }

где

  • "data": [] - содержит массив записей групп кампаний:

  • "errors": [] - содержит информацию о ошибках.

Коды ответов и ошибок

Код ответа

Пример JSON'а

Код ответа

Пример JSON'а

401 Unauthorized

Запрос:
https://api.uxfeedback.ru/v2/private/campaigns/groups?kind=all

Ответ:

{ "errors": [ { "code": "error.unauthorized.access-denied", "comment": "access-denied" } ] }

Пояснения:
Ошибка возникает, когда сам запрос корректный, но в ключе-токене допущена ошибка: используется токен авторизации от другого проекта или допустили опечатку в символах валидного токена => авторизация Клиента не проходит.

404 Not Found

Запрос:
https://api.uxfeedback.ru/v2/private/campaigns/group

Ответ:

{ "errors": [ { "code": "error.not-found.resource-not-found", "comment": "resource-not-found" } ] }

Пояснения:
Ошибка возникает, когда ресурс не найден, например: ошиблись с наименованием и написали …/group (или что-то другое) вместо …/groups.

400 Bad request

Запрос:
https://api.uxfeedback.ru/v2/private/campaigns/groups?kind=allgroup

Ответ:

{ "errors": [ { "in": [ "kind" ], "value": "allgroup", "code": "error.input.should-be-either-\"campaign\",-\"survey\"-or-\"all\"" } ] }

Пояснения:
Ошибка возникает в случаях, когда доп.параметры в строке запроса указаны неверно или вовсе не указаны, а запрос их ожидает (в частности, в параметре kind указано неверное значение, по которому не может быть обработан запрос)

В описании ошибки сообщается: каких значений не хватает или на что обратить внимание.

200 Ok

Запрос:
https://api.uxfeedback.ru/v2/private/campaigns/groups?kind=all

Ответ:

{ "data": [ { "id": 1, "name": "Имя группы 1", "kind": "campaign" }, { "id": 975, "name": "Имя группы 2", "kind": "survey" }, ... ], "errors": [] }

Пояснение:
Успешный ответ: в зависимости от указанного значения в kind отображаюся:

  • группы “активного фидбека”,

  • группы “опросов по ссылке”

  • или все вместе