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

У цій статті ви дізнаєтеся, як отримувати статистичні дані з вашого акаунта Snov.io за допомогою API-запитів.

Тут йтиметься про два типи запитів:

Get campaign analytics

View campaign progress

Розгляньмо їхні основні параметри та приклади використання.

Get campaign analytics

Перш ніж робити будь-який API-запит, отримайте «access_token» за допомогою запиту на автентифікацію: https://api.snov.io/v1/oauth/access_token.

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/statistics/campaign-analytics

Посилання на документацію до API.

Цей запит надає детальну аналітику ваших кампаній у Snov.io. Використовуйте його, щоб отримувати дані про загальну успішність кампанії або фільтрувати результати за кампаніями, відправниками, членами команди чи визначеними термінами.

Він також допоможе вам автоматично генерувати звіти на підставі даних з вашого акаунта та інтегрувати ваші Snov.io KPI у процес звітування.

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

Усі параметри в цьому запиті не є обов’язковими. Якщо ви не вкажете жодних параметрів, запит поверне статистику за весь час для всіх кампаній та акаунтів.

Щоб відфільтрувати ці дані, застосуйте відповідні фільтри в параметрах запиту. Повний список параметрів ви знайдете в документації до API.

Наприклад, поле «campaign_id» в параметрах запиту потрібно, щоб вказувати ідентифікатори (ID) кампаній, статистику яких ви хочете отримати. Тут можна вказати ID однієї або декількох кампаній одразу (через кому).

Щоб знайти ID кампанії, перейдіть до відповідної кампанії у списку. ID це число в кінці URL-адреси в адресному рядку вашого браузера (Приклад: в URL-адресі кампанії: https://app.snov.io/campaigns/2402609, тож ID кампанії – «2402609»).

А щоб відфільтрувати дані по конкретних членах команди, скористуйтеся полем «campaign_owner». Введіть в нього адреси електронної пошти, які члени команди використовують, щоб приєднатися до команди у Snov.io.

learn

Емейли членів команди знаходяться на сторінці Моя команда. Зверніть увагу, що вносити електронні адреси в поле «campaign_owner» можуть лише керівники команд у Snov.io, або користувачі, які мають право переглядати «Дані команди».

Результат запиту

Відповідь на запит містить усі стандартні метрики ваших кампаній у Snov.io, включно зі статистикою email-розсилок та автоматизацій LinkedIn.

learn

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

Загальні поля даних (email + LinkedIn):

"total_contacted";

Поля даних електронної пошти:

"contacted_by_email";"emails_sent";"first_emails";"follow_ups";"delivered";"bounced";"email_opens";"link_clicks";"email_replies";"unsubscribed";"auto_replied".

Поля даних LinkedIn:

"contacted_by_linkedin";"linkedin_total_replies";"linkedin_total_replies_rate";"connection_request_replies";"message_replies";"connection_requests";"accepted_requests";
"failed_connection_requests";"messages_sent";"linkedin_views";"linkedin_likes";"linkedin_follows".

За цим посиланням ви знайдете повний перелік полів, що надаються у відповіді API. А візуалізація цих даних міститься у вкладці «Кампанії» на дашборді «Звіти».

View campaign progress

Перш ніж робити будь-який API-запит, отримайте «access_token» за допомогою запиту на автентифікацію: https://api.snov.io/v1/oauth/access_token.

Тип запиту: GET

URL-адреса запиту: https://api.snov.io/v2/campaigns/[campaign_id]/progress

Посилання на документацію до API.

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

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

Цей запит має один необхідний параметр: ID кампанії – унікальний ідентифікатор кампанії у вашому акаунті Snov.io.

Щоб знайти ID кампанії, перейдіть до відповідної кампанії у списку. ID це число в кінці URL-адреси в адресному рядку вашого браузера (Приклад: в URL-адресі кампанії: https://app.snov.io/campaigns/2402609, тож ID кампанії – «2402609»).

Користуйтеся полем «campaign_id» в параметрах запиту, щоб вказати кампанію, прогрес якої вас цікавить. Один запит надає дані однієї кампанії. Щоб отримати прогрес для більшої кількості кампаній треба зробити додаткові запити.

Результат запиту

У полі «Progress», яке міститься у відповіді, вказується відсоток контактів, які завершили кампанію або зупинили її проходження. Причинами зупинки можуть бути: повернення емейлів, відповідь одержувача, автовідповідач або відписка, видалення одержувача з розсилки або його переміщення до іншого списку контактів.

За цим посиланням ви знайдете повний перелік полів, що надаються у відповіді API.

Поле «Unfinished» у відповіді показує кількість одержувачів, для яких кампанія лишається активною й досі не була зупинена (з причин, перелічених у полі «Progress»).

У результаті також вказується поточний статус кампанії на момент запиту. Більше про статуси кампаній ви можете дізнатися у цій статті.

Дякуємо за відгук!

Чи була стаття корисною?

Ні

Нам шкода 😢

Як нам покращити статтю?