API

Пример кода для передачи данных в систему Carrot quest

import requests
import json

# Список пользователей, которых нужно импортировать
# Первый элемент - User ID, второй - емейл
users = [
    (123, 'mail1@mail.ru'),
    (456, 'mail2@mail.ru'),
]

count = 0
auth_token = 'XXX' # TODO: подставьте сюда ваш auth_token

for u in users:
    # Свойства пользователя
    user_id = u[0]
    email = u[1]

    # Формируем адрес
    # Документация метода: https://carrotquest.io/developers/endpoints/users/props/
    url = 'http://api.carrotquest.io/v1/users/%d/props?auth_token=%s'
    url = url % (user_id, auth_token)

    # Будет только одна операция - установить емейл
    operations = [{"op": "update_or_create", "key": "$email", "value": email}]
    operations = json.dumps(operations)

    # Все готово, делаем запрос в соответсвии с параметрамит, описанными в документации
    requests.post(url, data={'operations': operations, 'by_user_id': True, 'app': '$self_app'})

    # Для наблюдения за ходом процесса
    count += 1
    print(count, len(users))

 

HTTP API

Описание API в разделе для разработчиков.

Как не учитывать меня в аналитике

Для того, чтобы система полностью игнорировала вас, нужно, чтобы в вашем браузере была кука carrotquest_notrack

Вам нужно зайти на ваш сайт, открыть консоль (F12 для браузера chrome), написать document.cookie = "carrotquest_notrack=1" и нажать на enter.

 

Чтобы это действовало дольше, можно написать:
document.cookie = "carrotquest_notrack=1; expires=Thu, 31 Dec 2037 23:55:55 GMT"

Не отслеживать до 2037 года.

URL API для записи событий и идентификации пользователей перешедших по ссылке

Благодаря URL API, можно сделать специальную ссылку, и человек, кликнувшей по ней, сразу после перехода совершит некое событие и к нему сразу будет записано свойство пользователя (например, емейл, тогда он перестанет быть анонимусом).

Описание URL API в разделе для разработчиков

 

Сбор данных о пользователях и их действиях с помощью JavaScript API

С помощью JavaScript API можно собирать данные о пользователе: отслеживать события и записывать свойства пользователя.

Полное описание JavaScript API в разделе для разработчиков.

Чтобы вставить JS-код, перейдите в "Трекинг" —> "Мастер сбора данных", найдите "Настроить JavaScript код" внизу страницы и нажмите кнопку "Начать".

Screenshot_1.png

 

Вам откроется окно, в которое вы можете вставить код:

e0bf201a1a.png

 

Ниже мы приведем несколько вариантов кода для наиболее частых случаев сбора информации с помощью JS API. Не забывайте, что это лишь часть возможностей.

 

Записать последние utm-метки

Наш сервис по умолчанию записывает в свойства пользователей первые utm метки. Но если вы хотите, чтобы наш сервис фиксировал и метки со следующих посещений, то нужно прописать следующий код:

 

Записать телефон из поля с маской

Предположим, что у нас есть поле с селектором #USER_PHONE.  Принцип работы будет следующим: при потере фокуса полем (пользователь закончил заполнять поле и кликнул в другое место на сайте) будет срабатывать метод identify, который будет записывать значение поля с телефоном в карточку пользователя.

Перенесем это на язык JavaScript: