Как получить UTM-метки в свою систему или бота

Эта инструкция поможет вам настроить получение UTM-меток и источника, откуда пришел подписчик через API. Следуйте шагам ниже:

 1. Что понадобится?

• Ваш API ключ от сервиса «Откуда Подписки бот».

 2. Какой метод используется?

Метод API: get_user_info
URL для запроса:

Этот метод возвращает откуда пришел подписчик и utm метки, если они есть по id пользователя в телеграм.

3. Формат запроса

Метод использует HTTP POST. Для передачи данных добавьте в тело запроса JSON-объект со следующими параметрами:

user_id (обязательный): ID пользователя в Telegram.

Пример запроса:

json
{
   "user_id": "123456789"
}
Code language: JavaScript (javascript)

4. Ответ API

В ответе вы получите JSON-объект с данными о пользователе. Пример ответа:

{
"status": "OK",
"data": {
"user_id": "123456789",
"first_join_date": 1680387078,
"last_join_date": 1680387078,
"invite_link": "Яндекс.Директ",
"left_date": 0,
"first_name": "Вася",
"username": "vasya",
"utm_source": "test_source",
"utm_medium": "test_medium",
"utm_campaign": "test_campaign"
}
}

5. Описание полей в ответе

• user_id: ID пользователя Telegram.
• first_join_date: Дата первой подписки пользователя в формате Unix Time.
• last_join_date: Дата последней подписки пользователя в формате Unix Time.
• left_date: Дата отписки формате Unix Time. Если пользователь не отписался, то 0
• invite_link: Источник первой подписки пользователя.
• first_name: Имя пользователя Telegram.
• username: Юзернейм пользователя (если есть).
• utm_source, utm_medium, utm_campaign, utm_content, utm_term: Значения UTM-меток. Если какие то метки не заданы, то они не возвращаются

6. Проверка корректности

Чтобы убедиться, что данные получены правильно:

1. Отправьте тестовый запрос с известным user_id.
2. Проверьте, что поля UTM-меток соответствуют вашим ожиданиям.

См. далее: Как настроить на глубокие цели