> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livingsecurity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Журнал фішингових електронних листів

> Відтворіть журнал фішингових подій попереднього постачальника на рівні окремих подій на основі подій і сутностей симуляцій у звітності /v1.

Цей звіт є журналом фішингових подій на рівні окремих подій: один рядок на кожну зафіксовану взаємодію із симуляцією (дата, дія, адреса електронної пошти отримувача, тема, відправник, складність). Він залишається в довгому форматі й не зводить історію окремої особи до єдиного результату.

Запит згортає останні **12 календарних місяців** у `occurred_after`
(північ за UTC того самого числа місяця дванадцять місяців тому — а не тривалість 365 днів).

<Note>
  Необроблена IP-адреса клієнта ніколи не передається в `/v1` — це приватність за задумом, а не відкладене зіставлення. Тип пристрою є похідним класом у рядку події; необроблений
  `user_agent` залишається приватним. Див.
  [Відмінності від застарілого експорту](#divergences-from-the-legacy-export).
</Note>

Налаштування, облікові дані, пагінація та повторні спроби за обмеження частоти запитів такі самі, як у
[посібнику з підключення Power BI / Excel](/uk/developers/v1/powerbi). Спочатку додайте спільний запит
`Fn_FetchAll`; цей звіт викликає його за назвою.

## Required key scopes

| Scope | Used for |
| - | - |
| `reporting:read` | `GET /v1/reporting/simulation_events` |
| `entity:read` | `GET /v1/entities` (приєднання за адресою електронної пошти та відображуваним іменем) |

Ключ, якому надано лише `simulation:read`, не може викликати кінцеву точку подій звітності (API повертає `403`). Див.
[вибір правильної деталізації](/uk/developers/v1/powerbi#%D0%B2%D0%B8%D0%B1%D1%96%D1%80-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D0%BB%D1%8C%D0%BD%D0%BE%D1%97-%D0%B4%D0%B5%D1%82%D0%B0%D0%BB%D1%96%D0%B7%D0%B0%D1%86%D1%96%D1%97).

## Source endpoints

| Endpoint | Role |
| - | - |
| `GET /v1/reporting/simulation_events` | Факт на рівні події. Деталізація — одна типізована взаємодія. `email_subject`, `sender_email`, `sender_domain` і `difficulty_tier` містяться в цьому рядку, тому запит не приєднує результати рівня кампанії для цих полів. |
| `GET /v1/entities` | Зіставляє `entity_id` → адресу електронної пошти / відображуване ім’я. Подія звітності не містить адреси електронної пошти отримувача (жорстке виключення в засобі читання звітності). Обхід `/entities` — це спосіб заповнення застарілого стовпця «email». |

Дозволені фільтри для списку подій (будь-які інші повертають `400`):
`limit`, `page_token`, `simulation`, `entity`, `event_type`,
`occurred_after`.

Це сімейство звітності є [попереднім набором даних](/uk/developers/v1/powerbi#%D0%BF%D0%BE%D0%BF%D0%B5%D1%80%D0%B5%D0%B4%D0%BD%D1%96-%D0%B7%D0%B2%D1%96%D1%82%D0%BD%D1%96-%D0%BD%D0%B0%D0%B1%D0%BE%D1%80%D0%B8-%D0%B4%D0%B0%D0%BD%D0%B8%D1%85-%D1%84%D1%96%D1%88%D0%B8%D0%BD%D0%B3-%D0%BD%D0%B0-%D1%80%D1%96%D0%B2%D0%BD%D1%96-%D0%BE%D0%BA%D1%80%D0%B5%D0%BC%D0%B8%D1%85-%D0%BE%D1%81%D1%96%D0%B1).
Перегляньте схему набору даних і політики щодо даних за адресами
`GET /v1/reporting/datasets` та
`GET /v1/reporting/datasets/simulation_events`.

### Grain

Один рядок на кожну подію симуляції у звітності. Особа, яка відкрила, а потім натиснула те саме повідомлення, створює два рядки. Події з порожнім `entity_id`
(без ініціатора / отримувача / цільового учасника) також відображаються — `email` має значення null.

Вікно API розширюється на одну хвилину; точна межа
`occurred_at >= WindowStart` повторно застосовується локально, щоб останній рік не залежав від того, чи сервер трактує `occurred_after` як включну, чи як виключну.

Бюджет запитів: один посторінковий обхід подій у вікні плюс один обхід сутностей. Завжди встановлюйте `limit = "500"`.

## Column mapping

Назви застарілих стовпців узято з експорту вашого попереднього постачальника. Поля `/v1` — це публічні назви API; запит дає деяким із них псевдоніми для звіту.

| Legacy column | `/v1` field or derivation | Report column |
| - | - | - |
| Date | `Event.occurred_at` (як дата; необроблений `occurred_at` зберігається як `datetimezone`) | `date` |
| Action | `Event.event_type` — закриті токени наведено нижче | `action` |
| Email | `Entity.email` (приєднання за `entity_id`) | `email` |
| Subject | `Event.email_subject` | `subject` |
| From | `Event.sender_email` | `from` |
| Difficulty | `Event.difficulty_tier` — ціле число 1–5, 1 — найлегше, 5 — найскладніше | `difficulty` |
| Raw IP | Ніколи не передається в `/v1` | Пропущено, а не замінено на null |
| Device type | `Event.device_type` — похідний клас; null, якщо подія не має похідного класу | `device_type` |

### Action tokens

`action` — це закритий токен звітності. Застаріле «Email Sent» відповідає
`simulation.delivered` (`delivered` — публічне дієслово; токен у каналі передачі — `simulation.delivered`).

| `action` value |
| - |
| `simulation.delivered` |
| `simulation.opened` |
| `simulation.link_clicked` |
| `simulation.credentials_submitted` |
| `simulation.attachment_opened` |
| `simulation.reported` |
| `simulation.bounced` |
| `simulation.qr_scanned` |
| `simulation.replied` |

Додаткові поля, збережені, оскільки вони є в API: `sender_domain`, `full_name`,
`event_id`, `entity_id`, `simulation_id`, `occurred_at`, а також
`entity_type` і `entity_status` з приєднання сутностей.

## Divergences from the legacy export

* **Необроблена IP-адреса недоступна ніколи.** `/v1` не надаватиме необроблену IP-адресу клієнта — це приватність за задумом, а не відкладене зіставлення. Запит не додає стовпець-заповнювач для IP.
* **Тип пристрою є похідним, а не необробленим.** `device_type` — це похідний клас пристрою для подій натискання, надсилання та повідомлення. Серед спостережуваних токенів: `desktop`, `mobile`, `tablet` і `unknown`, проте джерело зберігає довільний рядок — вважайте його відкритим текстом, а не закритим переліком. Значення null, якщо подія не має похідного класу, а необроблений рядок `user_agent` залишається приватним.
* **«Email Sent» — це `simulation.delivered`.** Використовуйте цей токен під час фільтрації або підрахунку надісланих листів. Не шукайте застарілий рядок `email_sent`.
* **Адреса електронної пошти отримувача — це приєднання, а не поле події.** Подія звітності не містить адреси електронної пошти; запит обходить `/entities`, щоб заповнити її.
* **Останні 12 календарних місяців**, а не тривалість 365 днів і не вся історія.
* **Довгий формат, без згортання.** Один рядок на взаємодію, а не один результат на особу.

## Next steps

<CardGroup cols={2}>
  <Card title="Налаштування Power BI та Excel" href="/uk/developers/v1/powerbi">
    Облікові дані, пагінація та завантаження цих запитів у Power BI або Excel.
  </Card>

  <Card title="Найуразливіші користувачі" href="/uk/developers/v1/reports/most-susceptible-users">
    Зведення за 12 місяців для кожної особи: натискання, облікові дані та повідомлення.
  </Card>

  <Card title="Відповідність вимогам для кожної особи" href="/uk/developers/v1/reports/per-person-compliance">
    Записи на Training на рівні «особа × призначення».
  </Card>

  <Card title="Ключі API" href="/uk/developers/developer-hub/api-keys">
    Надайте `reporting:read` і `entity:read` ключу, який оновлює цей звіт.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.