Скачать журнал сценариев в XLSX

GET /api/v1/bots/{uniqueId}/scenarios/routing-logs/xlsx

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/scenarios/routing-logs/xlsx

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Подробнее — авторизация API.

Параметры запроса

Параметры пути

Параметр	Тип	Обязательный	Описание
uniqueId	строка	Да	Идентификатор бота.

Параметры строки запроса

Параметр	Тип	Обязательный	Описание
skip	число	Нет	Количество пропускаемых диалогов.
take	число	Нет	Количество возвращаемых диалогов.
search	строка	Нет	Поиск по диалогу, запросу, сценарию и пояснению выбора.
status	SELECTED, NOT_SELECTED, CLARIFICATION_REQUESTED, CLARIFICATION_RESOLVED, CLARIFICATION_CANCELLED, CLARIFICATION_EXPIRED, FAILED, SKIPPED_ACTIVE_RUN	Нет
scenario_unique_id	строка	Нет	Отбирать записи по идентификатору сценария.
start_date	строка	Нет	Начало выбранного периода.
end_date	строка	Нет	Конец выбранного периода.

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

curl --request GET 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/scenarios/routing-logs/xlsx' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'skip=0' \
  --data-urlencode 'take=25'

Ответы

HTTP	Описание
200	Файл в формате XLSX.
400	Неверные настройки сценария.
401	Требуется авторизация.
403	Нет доступа к боту.
404	Бот или сценарий не найден.

Пример ошибки — HTTP 400

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}