Отчети по API

Матеріал з Planfix

У Planfix є два способи отримання даних звітів по API:

  • Сформувати звіт за розкладом і отримати його дані через REST API.
  • Запросити генерацію звіту через REST API і отримати його дані, коли він буде сформований.

Специфікація REST API доступна за посиланням.

Отримання даних зі звіту за розкладом через REST API

  • Створіть повторюваний звіт.
  • Створіть токен авторизації для співробітника, якому плануєте надсилати звіт. Збережені дані звіту доступні лише співробітникам, яких ви оберете для надсилання. Для створення токена перейдіть у Керування акаунтом — Доступ до API — REST API — Створити новий токен:
    • у полі "Співробітник / Контакт" вкажіть співробітника для отримання звіту за розкладом.
    • у полі "Дозволені Scope" вкажіть report_readonly.
  • Отримайте через REST API список звітів методом /report/list і знайдіть ідентифікатор потрібного звіту у відповіді (ідентифікатор звіту можна знайти в адресному рядку браузера).
  • Методом /report/{id}/save/list отримайте список збережених версій обраного звіту.
  • Отримайте дані звіту за ідентифікатором нової версії методом /report/{id}/save/{saveId}/data.

Особливості отримання даних

  • Збережені дані звіту доступні лише співробітникам, яких ви оберете для надсилання.
  • Якщо звіт великий, то у версії буде кілька частин (чанків/chunks). При отриманні даних звіту необхідно передавати індекс чанка, щоб отримати всі частини. Скільки чанків містить звіт видно у відповіді методу /report/{id}/save/list.

Генерація звітів через REST API

  • Створіть токен авторизації для співробітника, від імені якого буде формуватися звіт. Для створення токена перейдіть у Керування акаунтом — Доступ до API — REST API — Створити новий токен:
    • у полі "Співробітник / Контакт" вкажіть співробітника для отримання звіту за розкладом.
    • у полі "Дозволені Scope" вкажіть report_readonly.
  • Запустіть генерацію звіту методом /report/{id}/generate — у відповіді повертається requestId.
  • Через деякий час перевірте, чи готовий звіт методом /report/status/{requestId}.

Якщо звіт готовий — повертається об'єкт ReportSave (аналогічно звітам за розкладом).

  • Отримайте дані звіту за ідентифікатором збереженої версії методом /report/{id}/save/{saveId}/data.


Особливості генерації

  • Доступно лише на тарифі Plan X.
  • Не частіше ніж раз на 10 хвилин.
  • Не більше одного паралельно формуваного звіту.
  • Звіт формується від імені та з правами того, чиїй токен авторизації вказаний у REST API.

Перейти