Як отримати аналітику кампанії через API

Цей гайд пояснює, як отримувати аналітику кампаній і дані про залученість отримувачів за допомогою Snov.io API.

API аналітики та звітності в Snov.io надає доступ до даних про результати вашого аутрічу. Отримуйте прогрес кампаній, метрики залученості та активність отримувачів у email і LinkedIn-кампаніях через API-запити.

Що можна робити за допомогою цього API:

1) Відстежувати результати кампаній з email і LinkedIn
2) Синхронізувати залученість отримувачів із вашою CRM
3) Будувати внутрішні дашборди та звіти
4) Координувати воркфлоу на основі відповідей, відкриттів або переходів за посиланнями

Скористайтесь методом автентифікації, щоб отримати токен доступу. Включайте його як Bearer-токен у всі запити. Токен дійсний 1 годину (3600 секунд).

Перевірка кампаній і прогресу

Переглянути всі кампанії

Отримайте список усіх кампаній у вашому акаунті Snov.io, включно з їхніми ID та основними деталями.

Використовуйте цей метод, щоб отримати ID кампаній, необхідні для запиту даних в інших методах.

Які дані надає:

• ID кампанії
• Назва кампанії
• Статус кампанії
• Дата створення

Переглянути прогрес кампанії

Перевіряйте поточний статус і прогрес завершення конкретної кампанії.

Використовуйте цей метод, щоб відстежувати, чи кампанія активна, завершена, призупинена або потребує уваги.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• status: поточний статус кампанії (active, paused, completed, archived)
• progress: показує відсоток контактів, що досягли останнього кроку послідовності, і відсоток тих, для кого кампанія завершилась достроково через баунс, відповідь, автовідповідь, відписку, видалення або ручне виключення
• unfinished: кількість отримувачів, яким заплановані наступні кроки послідовності

Статистика та звіти кампаній

Використовуйте наступні методи для отримання метрик залученості та результатів кампаній.

Отримати аналітику кампаній

Отримайте агреговану статистику результатів по всіх кампаніях.

Використовуйте цей метод для формування звітів, відстеження KPI аутрічу та синхронізації статистики кампаній із зовнішніми дашбордами або інструментами для аналітики.

Обов'язкові параметри:

Вкажіть діапазон дат, за який хочете отримати статистику.

• date_from — початкова дата звітного періоду (РРРР-ММ-ДД)
• date_to — кінцева дата звітного періоду (РРРР-ММ-ДД)

Необов'язкові параметри є фільтрами для звуження повернутих даних.

• campaign_id — отримати аналітику для конкретної кампанії
• campaign_owner — отримати аналітику для конкретного учасника команди
• sender_email — отримати аналітику для конкретного email-акаунту відправника
• sender_linkedin — отримати аналітику для конкретного профілю LinkedIn

Які дані надає:

Відповідь містить агреговані дані про результати по email і LinkedIn-каналах:

• Загальні метрики аутрічу: загальна кількість охоплених контактів, заплановані імейли, надіслані імейли та загальна кількість виявлених баунсів
• Метрики залученості email: відкриття, переходи за посиланнями, відповіді, відписки, показник відкриттів, показник переходів за посиланнями, та показник відповідей
• Метрики активності LinkedIn: надіслані запити на контакт, прийняті запити, надіслані повідомлення та отримані відповіді

Отримати активність отримувачів кампанії

Отримайте детальні дані про залученість усіх отримувачів кампанії, включно з email і LinkedIn-взаємодіями.

Використовуйте цей метод для синхронізації даних залученості з вашою CRM, аналітичною платформою або інструментами для звітності.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• Активність email по кожному отримувачу: надіслано, відкрито, клікнуто, отримано відповідь, баунси
• Активність LinkedIn по кожному отримувачу: надіслані та прийняті запити на контакт, надіслані повідомлення та отримані відповіді
• Мітки часу для кожної події залученості

Отримати відповіді з кампанії

Отримайте відповіді на імейли, отримані в конкретній кампанії.

Використовуйте цей метод для передачі даних відповідей до вашої CRM або процесу автоматизації, коли потрібні лише email-відповіді без даних LinkedIn. Щоб отримати відповіді LinkedIn (запит на контакт, повідомлення, InMail) — скористайтесь методом «Отримати всі відповіді кампанії».

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• Тема імейлу та тіло повідомлення
• Крок послідовності, що був тригером для відповіді (step_number)
• Настрій відповіді, визначений ШІ (mood)
• Мітка часу відповіді

Отримати всі відповіді кампанії

Отримайте всі відповіді, отримані в конкретній кампанії, по email і LinkedIn-каналах.

Використовуйте цей метод для відстеження відповідей контактів і передачі даних відповідей до вашої CRM або процесу автоматизації.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• відповіді: email-відповідь або відповідь з LinkedIn
• Тема імейлу та тіло повідомлення
• Вміст відповіді LinkedIn
• Крок послідовності, що був тригером для відповіді (step_number)
• Настрій відповіді, визначений ШІ (mood)
• Мітка часу відповіді

Отримати відкриття імейлів

Отримайте дані про отримувачів, що відкрили імейли в кампанії.

Використовуйте цей метод для відстеження залученості email і вимірювання показника відкриттів.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• Кількість відкриттів імейлу
• Мітка часу першого відкриття та останнього відкриття

Отримати переходи за посиланнями

Отримайте дані про отримувачів, що перейшли за посиланнями в імейлах кампанії.

Використовуйте цей метод для відстеження переходів і результативності вмісту.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• URL, за яким перейшли
• Кількість переходів по кожному отримувачу
• Мітка часу переходу

Отримати надіслані імейли

Отримайте список імейлів, надісланих у межах кампанії.

Використовуйте цей метод для перевірки записів доставлення та відстеження активності відправлення.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• Використаний акаунт відправника
• Тема імейлу
• Номер кроку послідовності
• Мітка часу відправлення

Отримати завершені контакти

Отримайте контакти, що виконали всі кроки послідовності кампанії.

Використовуйте ці дані для визначення отримувачів, які завершили послідовність і можуть потребувати повторних повідомлень або зарахування до іншої кампанії.

Обов'язкові параметри:

• campaign_id — ID кампанії

Які дані надає:

• Дані контакту: ім'я, email-адреса
• Дата завершення послідовності контактом
• Останній досягнутий крок послідовності