URL API является частью нашего JavaScript API. Для того, чтобы он работал, должна быть установлена JS-библиотека (т.е. на странице должен стоять наш код).
API работает следующим образом: Когда пользователь переходит по специально сформированной ссылке, он сразу же совершает событие и ему будут установлены свойства пользователя.
http://example.com/?cq_event=MyEvent
Пользователь, перешедший по этой ссылке, совершит событие MyEvent.
http://example.com?cq_event=MyEvent&cq_event_param1=val1&cq_event_param2=val2
Человек, кликнувший по этой ссылке, совершит событие MyEvent,
и к этому событию будет записано свойство param1 со значением val1 и свойство param2 со значением val2.
http://example.com/?cq_identify_$email=my@email.com
Пользователю, перешедшему по этой ссылке, будет записано свойство $email со значением my@email.com
http://example.com/?cq_identify_myvalue=hello
Пользователю, перешедшему по этой ссылке, будет записано свойство myvalue со значением hello.
Следует помнить о правильном URL encode, "@” - символ неразрешенный, поэтому email должен выглядеть так: my%40email.com.
Можно комбинировать оба варианта. Например, вы делаете email-рассылку, в которой будет некая ссылка, и
вам нужно узнать, как вели себя пользователи, перешедшие по этой ссылке.
Вы хотите отправить пользователей на страницу http://example.com/some/page,
и чтобы все эти пользователи после перехода совершили событие FromMyEmail.
Большинство сервисов почтовой рассылки позволяют вставлять теги, так можно подставить email пользователя.
Например, в MailChimp есть тег *|URL:EMAIL|*, который позволяет вставить email (URL-encoded).
Тогда ссылка будет выглядеть так:
http://example.com/some/page?cq_event=FromMyEmail&cq_identify_$email=*|URL:EMAIL|*
вместо *|URL:EMAIL|* автоматически подставится email того, кому отправляется письмо.