Таймлайн підприємства

У цьому розділі описаний запит для роботи з таймлайном підприємства.

Таймлайн показує події, які були зафіксовані для підприємства в системі ESG SaveEcoBot. Кожен запис повертає короткі структуровані дані про сам об'єкт події та посилання, за якими можна перейти до відповідних даних в API.

GET /api/v1/enterprises/{registry_id}/timeline

Цей запит повертає події таймлайна підприємства в зворотному хронологічному порядку. У відповіді також повертаються структуровані блоки object, parent_object і links, щоб зовнішня система могла перейти до пов'язаних даних без розбору текстового опису. Повні деталі об'єктів у таймлайні не дублюються: для цього потрібно переходити за відповідними посиланнями. Доступні значення event можна отримати в запиті Події таймлайна.

Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/timeline" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "enterprise": {
      "type": "company",
      "registry_id": "00178353"
    },
    "items": [
      {
        "id": 1207031,
        "event": "created_permission_file",
        "type_label": "Додано файл дозволу",
        "object": {
          "resource": "permission_file",
          "id": 99881,
          "type_id": 5
        },
        "parent_object": {
          "resource": "permission",
          "id": 147,
          "type_id": 5
        },
        "links": {
          "object": {
            "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-files/147",
            "download": "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-files/147/download/99881"
          },
          "parent_object": {
            "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-files/147"
          }
        },
        "occurred_at": "2025-01-24T00:00:00+00:00",
        "created_at": "2026-04-28T05:24:07+00:00"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 34,
      "last_page": 2
    }
  },
  "stats": { "..." }
}

Параметри пагінації

page: номер сторінки.

Фільтри

after: повертає тільки записи, які були додані в таймлайн після вказаної дати й часу. Формат: YYYY-MM-DD HH:MM:SS.
event: повертає тільки записи одного типу події. Доступні значення можна отримати в запиті Події таймлайна.

Поля відповіді

`results.items[]`

id: ідентифікатор запису таймлайна.
event: технічний код події.
type_label: коротка людська назва типу події.
object: короткий структурований опис основного об'єкта події.
parent_object: короткий структурований опис батьківського об'єкта, якщо подія пов'язана з вкладеним ресурсом.
links: набір посилань на пов'язані дані в API.
occurred_at: дата й час самої події.
created_at: дата й час, коли запис з'явився в таймлайні.

`results.items[].object`

resource: технічний код типу ресурсу, наприклад report, permission_file, registry, court_case. Доступні поєднання event, resource і parent_resource можна отримати в запиті Події таймлайна.
id: ідентифікатор цього ресурсу в API.
type_id: ідентифікатор типу, якщо для ресурсу існує окрема типізація.

`results.items[].parent_object`

повертається в тому самому форматі, що й object;
використовується для вкладених ресурсів, наприклад для файла дозволу, файла реєстру, документа ОВД або документа СЕО.

`results.items[].links`

object: посилання на дані самого об'єкта події.
parent_object: посилання на дані батьківського об'єкта, якщо він є.

`results.items[].links.object`

набір посилань залежить від типу ресурсу;
це можуть бути details, files, download, documents, hearings, violations, sanctions, land_plots;
за цими посиланнями можна отримати повні дані об'єкта або пов'язані з ним записи.

`results.items[].links.parent_object`

набір посилань залежить від типу батьківського ресурсу;
найчастіше це посилання на загальний перелік пов'язаних даних, наприклад files або documents.

Приклад запиту

Приклад відповіді

Параметри пагінації

Фільтри

Поля відповіді

results.items[]

results.items[].object

results.items[].parent_object

results.items[].links

results.items[].links.object

results.items[].links.parent_object

Візьміть участь в тестуванні ESG профілю підприємства у системі SaveEcoBot