Экспорт результатов опросов, API

Выгружайте результаты опросов для отчетов и аналитики

В отличие от отзывов и товаров, где можно получить список всех отзывов/товаров, результаты опросов экспортируются по каждому опросу, отдельно.


Используйте для экспорта Platform API.

Сначала необходимо получить список опросов, для этого используйте метод "Список опросов", в ответе на запрос, в числе прочих, будут ID опросов, по которым уже можно экспортировать результаты.


Для экспорта результатов опросов используйте "Задачи на экспорт".

Необходимо:

  1. Создать задачу на экспорт отзывов с "records_type": "survey_responses", где в параметре "search_options" добавьте фильтр с ID опроса, результаты которого хотите экспортировать:

    "filter": {
         "survey_id":{
              "eq":"1234567abcdefg"
               }
         }
  2. Каждую минуту проверять статус задачи

  3. Если статус задачи изменился на completed — скачать файл по предоставленной ссылке

Подробнее читайте в документации.


Комментарии:

  • Чтобы не экспортировать каждый раз все результаты опроса, ускорить выгрузку и не выходить за лимиты, используйте "search_options" и экспортируйте только обновления отзывов. Для этого добавьте фильтр — товары, обновленные за временной отрезок (обычно наши клиенты делают выгрузки с периодичностью раз в час или раз в день):

    "search_options": {
         "filter": {
              "updated_at":{
              "gt": "YYYY-MM-DDThh:mm:ss"
              }
         }
    }
  • Для различных задач могут потребоваться и другие фильтры, примеры атрибутов ищите в описании метода по коллекции "Отзывы" в списке атрибутов, а доступные операторы в разделе Фильтрация.

  • Для ограничения или расширения кол-ва данных которые будут присутствовать в файле выгрузки, в форматах CSV или XLSX, используйте "export_format" и настройку формата экспорта данных*. Можно скопировать из личного кабинета и подкорректировать набор. Пример такого фильтра:

    "export_format": "[.id?, .created_at?, .author_name?, .author_email?, .order_number?,  .location?.name?, (.answers // [] | .[].value?)]"

Лимиты и ограничения

Существует ежедневная квота на длительность всех успешно завершенных экспортов — 60 минут. При превышении данной квоты, все новые задачи на экспорт будут отменены до начала следующего дня.

Данные ограничения распространяются на задачи всей компании, созданные как через ЛК, так и через Platform API.


Также существует лимит по кол-ву строк / единиц контента (отзыв, товар, вопрос, ответ и т.д.) — 500 000 строк за один экспорт. Если необходимо выгрузить больше единиц контента, выгрузку нужно разбить на части, например по временным отрезкам, или другим параметрам, воспользовавшись быстрыми фильтрами или продвинутым поиском, при выгрузке из ЛК, либо фильтрацией, при выгрузке через Platform API.


Ограничения распространяются на задачи всей компании, созданные как через ЛК, так и через Platform API.


Еще:

👆 На этом пока всё