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.

 

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

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

Склеивание пользователей зашедших на сайт с разных устройств или браузеров

Объединения пользователей с разных устройств по User ID

Carrot quest может объединять пользователей на нескольких устройствах (браузерах) в одного человека. Объединение происходит на основе параметра User ID, который вы должны передавать в Carrot quest.

 

Общая схема:

Для того, чтобы работало склеивание, необходимо настроить передачу User ID в наш сервис. Описание как настроить склеивание доступно в разделе для разработчиков

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

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

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

 

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

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

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