FAQ

Frequently asked questions

1. How can I configure push notifications on my site?

Add your site to the control panel and choose the platform "For website" -> "Chrome". Then follow the instructions that are given during the registration process. instructions for setting up Gravitec Web Push on your site can also be rather helpful.

2. How to set up push notifications in the mobile application on Android?

Create new "app" and choose the platform "For mobile App" -> "Android". Then follow the instructions.

3. I want to send push notifications to users that visit my site using mobile devices. What platform do I need to choose: "Android" or "Chrome"?

Choose Gravitec for Chrome. In this case push notifications will be delivered to Google Chrome browser both on desktop computers, and on mobile devices powered by Android.

Note: You should choose Push for Android App only if you want to use push notifications in your mobile application.

4. I already use push notifications from Gravitec on the one of my websites. How can I register another one in the control panel?

Open control panel, find and click "App list", in the left top corner of the screen, then choose "Create app" in that list. After that, choose "For website" -> "Chrome" and follow the instructions that are given during the installation process.

5. I activated my site in Gravitec, made some changes and the integration disappeared after that. How can I get the code for installing push notifications on my site again?

Open the "App list" menu, choose your site and find the "Installation" page. You can copy the code for integrating Gravitec with your site from here.

6. I’ve created a Gravitec account and added integration code to my website. How can I collect subscribers on my HTTPS-based website?

Your users can subscribe via the standard Chrome dialog box. Code for calling this dialog box can be found on the "Installation" page of control panel (located in "site management" section).

Alternatively, you can offer subscription on performing certain user actions on site.

Documentation for developers: https://docs.gravitec.net/hc/ru/articles/208904085-Website-SDK-HTTPS-Installation

Note: Regardless of the format, only visitors using Google Chrome browsers can subscribe to push notifications.

7. I've created a Gravitec account and added integration code to my website. How can I collect subscribers on my HTTP-based website?

You can use the standard Gravitec widget.

Choosing widget colors, changing widget text and getting integration code can be done on "Installation" page of control panel (click "App list" menu and choose your site).

Alternatively, you can offer subscription on performing certain user actions on site.

Documentation for developers: https://docs.gravitec.net/hc/ru/articles/208244269-Website-SDK-HTTP-Installation

Note: Regardless of the format, offer to subscribe to push notifications will be shown only to visitors that use Google Chrome browser.

8. Can I send push notifications directly from my website instead of using the control panel?

Yes, it’s possible to send push notifications from your own server using our API. Here is the documentation for developers: https://docs.gravitec.net/hc/en-us/articles/360001415573-Send-Push-Notification-V3

9. How can I send personal notifications to individual subscribers?

Give unique names (aliases) to your subscribers. Usernames, phone numbers or emails can be used for this purpose.

Send unique messages to unique users using their aliases. Use our API for setting aliases for users. Here is the documentation for developers: https://docs.gravitec.net/hc/ru/articles/208958285-Website-SDK-API

  10. How can I group and target certain subscribers?

You can create subscriber groups using special tags. Use these tags for segmenting and grouping your subscribers. You can use as many tags as you want. Use our API for setting tags for users. Here is the documentation for developers: https://docs.gravitec.net/hc/ru/articles/208958285-Website-SDK-API

  11. I have more questions. Where can I get answers?

Feel free to ask us: support@gravitec.net

We will surely help you with your issue!

Как начать пользоваться сервисом

Для того, что бы начать использовать сервис Gravitec нужно:

    1. Зарегистрироватся по адресу https://push.gravitec.net/register
    2. Добавить Ваши ресурсы в аккаунте


mceclip0.png

  1. На ресурс устанавливается код интеграции с нашим сервисом. 

    mceclip1.png

3.  Для HTTPS ресурсов устанавливаются файлы SDK.  В личном кабинете в настройках сайта, нужно скачать файлы SDK и разместить их в корневой папке сайта, чтобы к ним был доступ по ссылкам: https://sitename.com/push-worker.jshttps://sitename.com/manifest.json.  

mceclip2.png


3.1. Посетитель заходит на ваш сайт, ему выпадает попап с предложением подписаться на получение уведомлений от сайта.


mceclip3.png

3.2. Посетитель дает свое согласие (нажимает «Разрешить» на выпавшем попапе). Только после этого он (посетитель) становится подписчиком. Таким образом формируется база подписчиков, которым вы впоследствии сможете рассылать push-уведомления.

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

Подробнее о сегментации тут: https://docs.gravitec.net/hc/ru/articles/208958285-Website-SDK-API.

 

Интеграция с сервисом сайта на Tilda

Конструкторы сайтов не дают возможности размещение файлов в корне сайта. А для использования технология пуш-уведомлений, требуется установка файлов SDK(push-worker.js и manifest.json) в корне сайта.

Есть возможность интеграции вашего сайта на tilda с нашим сервисом по принципу http сайтов.

Изначально технология пуш создана Google для https сайтов. Для использования ее на http сайтах генерируется поддомен вида https://sitename.gravitec.net и подписка осуществляется в 2 клика: один раз на основном домене (виджет), а второй раз в поддомене Gravitec. 
Для этого нужно:
1. Зарегистрировать аккаунт по ссылке - https://push.gravitec.net/register
2. При входе в кабинет, добавляете сайт выбрав протокол http - http://joxi.ru/brRBEGRTYkRvqr
3. Копируете сгенерированный скрипт подписки для добавленного сайта. 

Вот пример, как можно провести интеграцию с тильда с помощью установки скрипта подписки по этим примерами - http://help-ru.tilda.ws/tips/javascript.

 

Кастомизация пуш-уведомления и окна подписки

В сервисе Gravitec.net существует возможность изменения внешнего вида пуш-уведомления и окна подписки на push под задачи и цели конкретной кампании. Приведенная инструкция поможет разобраться в специальных функциях и возможностях для привлечения подписчиков. Опции разработаны для http и https-сайтов.  

Структура пуш-сообщений 

В каждом браузере (Chrome, Opera, Firefox, Yandex, Safari на десктопных операционных системах и ОС Android) пуш на стороне клиента (после подписки) отображается по-своему. Однако, структурные элементы уведомления общие для всех: 

  • заголовок; 
  • текст; 
  • картинка. 

В рамках стандартного набора функций можно следовать таким основным рекомендациям при планировании рассылки: 

  1. Заголовок должен содержать цепляющую, конкретную и понятную информацию. Положительно на конверсии сказывается употребление цифр (например, “Скидка 30%”), руководства к действию (к примеру, “Подключи прямо сейчас”), кричащих анонсов событий, упоминания ТОПовых новостей. 
  2. Следует в уведомление добавлять яркие картинки. Хорошо привлекают внимание узнаваемые сюжеты: лица известных людей, именитые бренды и логотипы (например, есть смысл использовать логотип известной компании при проведении совместной с ней акции). 
  3. Для каждой новой рассылки заголовки, текст и изображения должны отличаться. Статистика говорит в пользу разнообразия: кейсы реальных кампаний указывают на значительное повышение CTR после отказа от однотипных рассылок (одинаковые картинки, заголовки). 

Дополнительные элементы пушей

Кроме использования типичного набора структурных частей push-уведомления, разработчики компании Gravitec.net расширили возможности отправителей за счет дополнительных элементов: 

  • большие картинки; 
  • одна или две функциональные кнопки. 

Такие функции в полном объеме доступны в десктопных версиях Google Chrome и Yandex: 

 

А также на платформе Андроид в Chrome mobile: 

 

Кроме того, дополнительные кнопки можно использовать на ОС Андроид для Yandex mobile:

и Opera mobile 

 

Для каждой кнопки можно задавать: 

  • название (до 48 символов); 
  • иконку; 
  • url для перехода на разные страницы (поддерживаются utm-метки). 

Такие дополнительные элементы существенно расширяют возможности взаимодействия с пользователями и область применения пуш-уведомлений. К примеру, две кнопки в push-сообщении можно задействовать для сегментации подписчиков по интересам (выбор товара из двух конкурентных групп, допустим, “Лыжи” и “Сноуборд”). Еще один вариант из множества — определение более актуальных тем и страниц сайта и т.п. 

Минимальный размер больших картинок — 360х240 пикселей. При увеличении изображения необходимо соблюдать пропорцию сторон 1.5 к 1. Поддерживаемые форматы: JPG, PNG, GIF — до 200 Кб. 

Использование больших картинок, как правило, влияет на рост CTR, узнаваемость бренда. Такие изображения пользуются повышенным вниманием пользователей и мотивируют их к действиям (клику по уведомлению). 

Окно подписки для http и https-сайтов 

Изначально пуш-технология была разработана Google только для сайтов с https-протоколом. На таких веб-ресурсах подписка осуществляется в один клик. Однако сервис Gravitec.net предоставляет возможность подключать push-уведомления и к http-сайтам.  

Дизайнерское и нативное окно подписки для http-ресурсов 

На сегодняшний день подписаться на “пуши” http-сайта можно только в два клика. Почему? Для того, чтобы обойти ограничение Google для http, сервис Gravitec.net автоматически создает https-страницу на своем поддомене вида https://sitename.gravitec.net. Соответственно, подписка происходит уже на этом поддомене. Потому первое всплывающее окно привязано к http-странице для перехода на https, где появляется второе сервисное сообщение браузера. Первый pop-up, как правило, по внешнему виду максимально приближен к привычному окну браузера. Такой подход дает лучшие результаты, поскольку сообщение воспринимается пользователем более доверительно.

Кастомизация первого окна возможна (индивидуальный дизайн), однако, основываясь на опыте многих кампаний, оригинальность в данном случае ухудшает финальные результаты (конверсия подписки снижается в 3-5 раз).  

Так выглядит pop-up на http:

 1 click push http pop-up Gravitec

А так выглядит окно подписки на поддомене https:

https push native

Нативный или кастомизированный виджет подписки для https-сайтов? 

Для https-сайтов кастомизация стандартного окна подписки невозможна, так как это системное сообщение браузера (один клик по кнопке “Разрешить” или “Блокировать”). Однако существует возможность внедрения оригинального дизайна при условии увеличения числа кликов. То есть, для реализации такого варианта первый pop-up будет дизайнерским, а второе окно — стандартное сервисное сообщение браузера.  

Компания Gravitec.net не рекомендует своим клиентам увеличивать число кликов для подписки на “пуши”, потому как любой дополнительный клик существенно снижает конверсию. 

Именно поэтому средняя конверсия подписки http-сайтов (в два клика) составляет 1-1,5% от общего числа неуникальных посещений в месяц. Этот показатель в 3-6 раз ниже аналогичного для https-ресурсов. 

Prompt & Bell settings RU

Block+override+(re-engagement)

Block override (re-engagement) 

Клиентам сервиса Gravitec доступен виджет разблокировки подписки. Параметризация данного виджета-колокольчика позволяет подписчикам:

  • Получить подсказки как разблокировать подписку;
  • Настроить условия повторного отображение окна подписки.

(warning)Виджет доступен только для тарифа Business.

Для настройки виджета необходимо:

-В боковом меню выбрать пункт Подписка & Виджет;

-Перейти на вкладку Разблокировка.

Вкладка имеет следующий вид:

Для конфигурации данного виджета необходимо установить следующие параметры:

  1. Разблокировка подписки - чек-бокс, который активирует и деактивирует виджет;

(info)Если деактивировать виджет, режим предпромотра недоступен.

2. Основний цвет - текстовое поле, в которое можно ввести код цвета, или вібрать из существующей палитр;

3. Предпросморт - визуальное представление виджета с учетом выбранного цвета;

4. Позиция колокольчика - выпадающий список. Позволяет задать с какой стороны будет отображаться виджет;

5. Предварительный просмотр на вашем сайте - визуальное представление виджета с учетом его цвета и расположения;

Для задания условия повторного открытия окна подписки есть два варианта:

6. Через определенное количество прочитанных ссылок на сайте;

(info)Обновление страницы тоже считается как переход по ссылке.

7. Через определенного количество дней/часов после предыдущего нажатия на кнопку Заблокировать в окне подписки.

(info)Время повторного открытия окна подписки фиксируется в cookie. После закрытия браузера, файл cookie не удаляется, и после повторного открытия сайта счетчик времени работает дальше.

8. Блок кнопок сохранения. Есть возможность сохранить изменения или отменить их.

(warning)Если при переходе на другую вкладку настроек подписки и виджетов будут не сохраненные данные, отобразится конфирм-попап. У пользователя будет возможность применить или сбросить внесенные правки.

 

 

Bell+Configurator

Bell Configurator

Сервис Gravitec.net позволяет конфигурировать внешний вид и функциональность виджета колокольчика. Данный виджет позволяет подписчикам просматривать ранее полученные, непрочитанные кампании. Также колокольчик позволяет подписчику персонифицировать предпочтения контента и получать только интересную информацию, увеличивая лояльность к сайту.

Для начала настроек виджета необходимо открыть в боковом меню сайта пункт Подписка & Виджет, и перейти на вкладку Колокольчик.

 

Пока не активированы функции колокольчика, он остается неактивным и не отображается подписчикам.

Для начала необходимо определить как будет выглядеть данный виджет для подписчиков. Для этого необходимо установить следующие параметры:

  1. Основной цвет - Если Вы точно знаете код желаемого цвета, его можно указать в текстовом поле. Так же при клике на цвет открывается палитра, где есть возможность подобрать цвет самостоятельно.

 

(info)Выбранный цвет сразу же отображается в блоке предпросмотра.

(warning)Для обладателей тарифа Free будет отображаться брендинг сервиса.

(warning)Если ранее был активирован функционал колокольчика разблокировки, учтите что это разные виджеты и их цвета могут отличатся.

2. Позиция колокольчика - выпадающий список. Колокольчик можно размещать в левом или правом нижнем угле на выбор.

Функции колокольчика

  1. История 

Данная функция позволяет увеличить количество переходов, так как подписчики могут открывать ранее непрочитанные уведомления. При активации функции в блоке Предварительный просмотр на вашем сайте отображается виджет, с учетом настроек цвета и позиции.

История push-уведомлений открывается при клике на колокольчик и имеет следующий вид и элементы:

Закрыть историю можно нажав на соответствующую кнопку Х.

2. Настройки интересов 

Позволяет подписчикам получать новости, отвечающим их интересам. Для конфигурации необходимо:

-Активировать функцию Настройка интересов;

-Заполнить поле Название. В поле можно указать что можно выбрать интересы;

-Заполнить поле Текст. В поле можно указать дополнительную информацию;

-Интерес по умолчанию. Категория контента, которую будут получать подписчики, которые не указали интересы.

-Тег. Позволяет привязать тег к определенному интересу;

-Новая категория. Добавляет к списку интересов новое значение;

-Кнопки навигации. Позволяет расположить интересы в необходимом порядке;

-Кнопка удаления.

(info)Внесенные значения доступны для предпросморта.

(info)Если активировано несколько функций колокольчика, они отображаются как отдельные вкладки.

После внесения изменений их можно сохранить или отменить изменения.

(warning)Функции виджета доступны только для desktop версий сайтов!

(warning)Если при переходе на другую вкладку настроек подписки и виджетов будут не сохраненные данные, отобразится конфирм-попап. У пользователя будет возможность применить или сбросить внесенные правки.

Permission Prompt

Permission Prompt

При открытии сайта, который прошел интеграцию с сервисом Gravitec у посетителей есть возможность подписаться на push-уведомления. Подписка происходит через окно подписки, внешний вид которого можно настроить .

Для настроек конфигурации окна подписки необходимо:

-В боковом меню сайта выбрать пункт Подписка & Виджет;

-Выбрать вкладку Подписка.

Страница настроек окна подписки имеет следующий вид:

Для кастомизации окна подписки необходимо заполнить следующие параметры и поля:

  1. Выбрать необходимую вкладку настроек
  2. Платформа - переключатель, позволяющий выбрать настройки для каждой из платформ (Desktop и Mobile)
  3. Внешний вид - переключатель, позволяющий выбрать форму и тип окна подписки. По умолчанию Тост.

(info)Нативное окно подписки уже недоступно, если в настройках был указан данный тип, необходимо его изменить.

4. Позиция - переключатель, позволяющий выбрать место размещения окна подписки (верхний/нижний, левый/правый угол экрана или по центру);

5. Задержка, сек - параметр времени пребывания на сайте, после который будет показываться окно подписки;

(info)Необходимо учитывать то что отсчет идет после того момента, как будут загружены все скрипты сайта;

6. Цвет кнопки, Цвет текста запроса - текстовое поле, в который можно ввести код цвета, или выбрать из палитры.

7. Настройки языка виджета подписки на desktop - настройка мультиязычности окна подписки.

(warning)Для добавления нового языка для окна подписки необходимо:

-Нажать на кнопку Редактировать (карандаш) и в всплывающем окне выбрать необходимые языки;

-Задать значения для полей Текст запроса, Кнопка “Отказаться”, Кнопка “Подписаться”;

-Сохранить.

(info)Владелец(Администратор) устанавливает дефолтный язык для сайта в html и задает дефолтное значение текста в окне подписки через сервис. Также сервис при входе на сайт определяет язык браузера подписчика. Если в настройках есть значения для данного языка, окно подписки отображается на нем, если нет- значение по умолчанию.

8. Текст запроса, Кнопка “Отказаться”, Кнопка “Подписаться” - текстовые поля. Заполните значение по умолчанию или для нескольких языков, и посетители сайта увидят данный текст

9. Блок Предпросморт. Визуальный вид окна подписки с учетом параметров 2-8.

10. Блок кнопок сохранения. Есть возможность сохранить внесенные данные, или отменить изменения.

(warning)Окно подписки для мобильной платформы заполняется отдельно. Если не будет внесено изменений, окно подписки будет иметь дефолтные значения.

(warning)Если при переходе на другую вкладку настроек подписки и виджетов будут не сохраненные данные, отобразится конфирм-попап. У пользователя будет возможность применить или сбросить внесенные правки.

(warning)Для владельцев тарифа Free на окне подписки будет отображаться брендинг сервиса.

Gravitec.net features RU

Profile tab

Profile tab

На данной вкладке пользователь имеет возможность:

  • Внести, изменить или удалить личные данные, информацию об отрасли компании и занимаемую в ней должность;
  • Добавить или удалить контакты работников, которые ответственные за платежи.
  • Изменить логин и пароль для входа в сервис;

Вкладка имеет следующие элементы:

 

1. Панель переключения вкладок;

2. Имя, фамилия - текстовое поле;

3. Телефон - текстовое поле;

4. Skype - текстовое поле;

5. Отрасль - выпадающий список;

6. Должность - выпадающий список;

7. Дополнительная информация - текстовое поле, в которою можно внести комментарии, или указать данные, если их не было в перечне Отрасль и Должность;

8. Блок изменения логина и пароля;

9. Контакт для выставления счетов - текстовое поле. Принимает только значения email;

10. Контакт для получения отчетов - текстовое поле. Принимает только значения email;

11. Обновить - если были внесены какие-либо изменения на странице, при нажатии на кнопку они сохраняются.

Добавление информации пользователя

Для обновления информации профайла необходимо:

-Внести данные в поля 2-7.

-Нажать кнопку Обновить.

Изменения сохраняются и отображаются в профайле.

Добавление биллинговой информации

Администратор сервиса может указать контакты, которые ответственны в компании за платежи. Для этого необходимо:

-Внести необходимый email в поля 9 и/или 10;

-Нажать кнопку Добавить(+).

После добавления email отображается над полем.

(info)Можно добавить не больше пяти адресов для каждого из контактов.

 

Изменение логина пользователя

Email пользователя является одновременно и логином для входа в сервис. Пользователь имеет возможность изменить его.

Блок изменения логина/пароля имеет следующие элементы:

 

  1. Email - поточное значение почты пользователя. (Невозможно изменить вручную, по аналогии с полем Имя, фамилия);
  2. Пароль - поточное значение пароля (в зашифрованном виде);
  3. Изменить email - при нажатии на кнопку открывается форма изменения почты;
  4. Изменить пароль - при нажатии на кнопку открывается форма изменения пароля;

Чтобы изменить почту необходимо:

  • Нажать кнопку Изменить email;
  • В открывшийся форме заполнить поля:

-Новый email адрес - новая почта, к которой будет привязан аккаунт сервиса;

(warning)Невозможно указать email уже существующего пользователя.

-Подтвердите свой пароль - введите поточный пароль от сервиса;

  • Нажать кнопку Изменить;

 

После отправки запроса на изменение почты отображается уведомление о необходимости активации нового электронного адреса. Также отображается плашка, информирующая о статусе запроса.

(warning)Письмо с активацией отправляется на поточный email аккаунта.

(warning)Если нажать кнопку Отмена, запрос становится отмененным, письмо с активацией- неактивным.

  • Открыть присланное письмо и нажать кнопку Подтвердить;

 

После подтверждения смены почты новое значение отображается в профайле.

 

(info)Если пользователь создал аккаунт через WordPress-плагин и не активировал его на этапе анбординга, то на странице профайла недоступно поле пароля.

 

Первое изменение email доступно без ввода пароля:

 

Письмо для подтверждения смены почты отправляется на новый адрес. При подтверждении почты происходит и установка пароля.

Изменение пароля

Для изменения пароля необходимо:

  • Нажать кнопку Изменить пароль;
  • В открывшийся форме заполнить поля:

-Текущий пароль - ввести текущий пароль аккаунта;

-Новый пароль - новое значение пароля;

(info)Новый пароль не должен быть такой же как и старый, иметь минимум 8 символов, содержать в себе цифры и латинские символы.

-Подтвердите новый пароль - подтвердите новый пароль.

  • Нажать кнопку Изменить.

 

(info)После изменения пароля на почту приходит письмо с уведомлением о смене пароля. Если смена пароля была инициирована не Вами, есть возможность его сбросить.

 

Team tab

Team tab

Данная вкладка Настроек профиля позволяет добавлять подчиненных и управлять их правами и доступами.

(warning)Данная вкладка доступна только для пользователей с тарифным планом Business. При клике на кнопку Сменить тарифный план на Business открывается страница биллинга для пополнения счета.

 

При переходе на вкладку отображается таблица с списком пользователей.

 

Таблица имеет следующие поля:

Имя - Имя пользователя;

Email - Email;

Статус - один из статусов: Запрос отправлен, Активный, Неактивный;

Дата активации - дата создания нового пользователя;

Действия - действия, доступные над аккаунтом пользователя;

А также кнопка Добавить пользователя.

Создание нового пользователя

Для создания нового пользователя необходимо:

  • Нажать кнопку Добавить пользователя;
  • В открывшейся форме заполнить поля:
  • Email - почта, которая будет привязана к аккаунту пользователя;
  • Имя - имя нового пользователя;
  • Нажать кнопку Добавить

Новый созданный пользователь отображается в списке пользователей в статусе = запрос отправлен. После подтверждения почты и установки пароля статус пользователя меняется на Активный.

(info)Есть возможность отправить повторно запрос на активацию нового аккаунта.

Выдача прав на сервис новым пользователям

Созданным пользователем можно выдавать права на все или отдельные сайты. Для этого необходимо:

- В записи интересующего пользователя нажать на кнопку Редактировать (1).

  • В списке сайтов(2) отметить те, на которые необходимо выдать права;
  • При активации чек-бокса Выбрать все сайты(3) выбираются все сайты (на момент выдачи прав);
  • При активации чек-бокса Доступ ко всем новым сайтам(4) доступ ко всем добавленным позже сайтов будет выдаваться автоматически.

 

Деактивация пользователя

Также есть возможность деактивировать пользователя, то есть возможность ограничить ему доступ к сервису. Для этого необходимо нажать кнопку Деактивировать и подтвердить действие в сплывающем окне

 

После деактивации пользователя его статус меняется на Неактивный.

(info)Также есть возможность повторно активировать неактивного пользователя. Для этого достаточно нажать кнопку Активировать и подтвердить действие в сплывающем окне. После активации пользователя его статус вновь меняется на Активный.

 

(warning)Доступ даже для активных пользователей возможен только при условии что администратор сервиса находиться на тарифе Business.

(warning)Добавленные пользователи не могут менять себе email, только пароль.

Для того, что бы начать использовать сервис Gravitec нужно:

    1. Зарегистрироватся по адресу https://push.gravitec.net/register
    2. Добавить Ваши ресурсы в аккаунте


mceclip0.png

  1. На ресурс устанавливается код интеграции с нашим сервисом. 

    mceclip1.png

3.  Для HTTPS ресурсов устанавливаются файлы SDK.  В личном кабинете в настройках сайта, нужно скачать файлы SDK и разместить их в корневой папке сайта, чтобы к ним был доступ по ссылкам: https://sitename.com/push-worker.jshttps://sitename.com/manifest.json.  

mceclip2.png


3.1. Посетитель заходит на ваш сайт, ему выпадает попап с предложением подписаться на получение уведомлений от сайта.


mceclip3.png

3.2. Посетитель дает свое согласие (нажимает «Разрешить» на выпавшем попапе). Только после этого он (посетитель) становится подписчиком. Таким образом формируется база подписчиков, которым вы впоследствии сможете рассылать push-уведомления.

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

Подробнее о сегментации тут: https://docs.gravitec.net/hc/ru/articles/208958285-Website-SDK-API.

 

RSS to Push

RSS to Push

Сервис Gravitec.net позволяет совершать рассылки из RSS-ленты. При добавлении нового контента на сайт происходит рассылка push кампании подписчикам.

Для начала настройки автоматизированных рассылок из RSS необходимо:

  1. Выбрать в боковом меню сайта пункт Автоматизация;
  2. Нажать кнопку Активировать в блоке RSS to Push.

 

 

На странице настроек RSS-рассылок отображается список RSS-каналов. Для добавления новой записи необходимо нажать кнопку Добавить новый RSS-канал.

 

После нажатия на кнопку открывается всплывающее окно. Необходимо заполнить следующие поля:

  1. Название - текстовое поле;
  2. RSS URL - текстовое поле, на вход принимает ссылки типу https://yoursite/rss;
  3. Порядок загрузки данных push-кампании - С помощью кнопок навигации можно изменять приоритет источников контента.
  4. При нажатии на кнопку с справкой можно увидеть примеры meta тегов.

5. Сохранить - при нажатии на кнопку сохраняется все изменения;

6. Отмена - всплывающее окно настроек содержимого уведомления закрывается, данные не сохраняются.

После сохранения нового RSS-канала всплывающее окно закрывается и записи добавляются в списке в статусе Новый.

 

Далее необходимо настроить параметры рассылок. Кликнув на интересующий RSS-канал или кнопку Редактировать, открывается страница настроек. Для каждого RSS-канала есть возможность задать тип Срочные новости или Топ новости.

Настройка срочных новостей

Список срочных новостей берется из Вашей RSS-ленты, и так только появляется новый контент, отвечающий настройкам заданных категорий идет отправка push-кампании (согласно установленных расписанию и лимитов). Для настройки необходимо заполнить следующие поля:

 

  1. Срочные новости - вкладка настроек по умолчанию;
  2. Выбранный интервал - ползунок с возможностью задать интервал времени, в который будет происходить рассылка;
  3. Лимит кампаний, в день - ползунок, который позволяет задать лимит количества рассылок;

(warning)Для тарифа Free доступна отправка не более 5 кампаний в день.

Кампании, которые не оправились через превышение лимита выделяются красным и имеют соответствующий статус в Истории рассылок.

 

4. Выберите часовой пояс рассылки - выпадающий список с возможностью поиска;

5. UTM - переключатель, который активирует специализированный параметр в URL, используемый маркетологами для отслеживания ресурсов, с которого передаётся трафик;

(info)При активации переключателя отображается дополнительное необязательное поле Название кампании

6. Информация о работе рассылке на основе RSS-ленты и ссылка на блог сервиса;

7. Блок загрузки новой иконки для рассылок;

8. Отправить на - параметры отправки кампаний для определенных подписчиков. Доступны рассылки на:

-Всех - все подписчики ресурса;

-Категории - отправка происходит только для указанных категорий подписчиков;

-Сегменты - отправка происходит только для указанных сегментов подписчиков. Есть возможность дополнительного ограничения по категориям и задать лимиты кампаний.

9. Порядок загрузки данных push-кампании - С помощью кнопок навигации можно изменять приоритет источников контента.

10. Добавить кнопки - дополнительные настройки, дозволяющее настроить отображение кнопок в push’е, который получает подписчик. При клике на кнопки будет происходить переход на указанную ссылку.

11. Сохранить - при нажатии на кнопку сохраняется все изменения;

12. Сохранить и активировать - при нажатии на кнопку сохраняется все изменения, статус RSS-канала становится Активно;

13. Отмена - всплывающее окно настроек закрывается, данные не сохраняются.

Настройка ТОП-новостей

Рассылка ТОП-новостей базируется на отправленных срочных новостях. Сервис определяет те кампании, которые имеют самое большое количество просмотров за период, прошедший с момента предыдущей автоматизированной рассылки. С этих кампаний и будет формироваться отправка ТОП-новостей.

Для настройки параметров необходимо перейти на вкладку Топ-новости. Перечень настроек такой же как и для Срочных новостей, кроме параметра Отправить на. (question)Топ-новости всем подписчикам отправляются? (question)

После настроек рассылок есть возможность:

-Поставить на паузу/Активировать рассылку;

-Редактировать настройки.

После настроек и активации рассылок есть возможность видеть сведенную информацию о них. При клике на кнопку История происходит редирект на История рассылок.

Также в истории рассылок отображаются запланированные автоматические рассылки, которые будут отправлены на протяжении суток.

Drip campaigns

Drip campaigns

Push серии (они же Drip campaigns) позволяют создать несколько push-кампаний, которые будут оправляться всем новым подписчикам согласно установленному расписанию.

Чтобы перейти на страницу Push серий необходимо:

  1. Выбрать в боковом меню сайта пункт Автоматизация;
  2. Нажать кнопку Активировать в блоке Push серии.

 

Страница настроек Push серий имеет следующие элементы:

-Таблица статистики, имеющая метрики (количество + процентное соотношение):

  • Отправлено
  • Доставлено
  • Просмотрено
  • Открытый
  • Закрыто

(info)Статистика по рассылкам, на подобии той, что имеется на странице История рассылок, но только по push-сериям.

-Информационную плашку с общей информацией о push сериях и ссылкой на блог сервиса.

-Кнопка Новая push серия.

 

Создание новой push серии

Создание серии можно поделить на 2 этапа: настройки параметров отправки и добавление кампаний.

Настройка параметров отправки

  • Нажать кнопку Новая push серия;
  • В открывшемся окне указать следующие параметры:

 

  1. Название - обязательное текстовое поле. Название push серии;
  2. Дата начала - календарь, обязательное поле. День, начиная с которого будет запущена отправка цепочки рассылок;

 

3. Дата окончания - календарь. День окончания отправки цепочки рассылок. Данный параметр не обязателен для заполнения;

 

4. Интервал между кампаниями по умолчанию (дней): 1 - ползунок. Задает промежуток между отправкою очередной рассылки. По умолчанию- один день;

5. Отправить первую кампанию в - селектор, дающий возможность указать время начала первой рассылки.

 

  • После успешного заполнения параметров рассылки нажать кнопку Далее(6).

(info)В случае если Вы передумали, нажмите кнопку Отменить изменения(7), но тогда внесенные данные будут утрачены.

Добавление кампаний в серию

-В появившейся поле Вставить ссылку добавить URL кампании;

-Нажать кнопку Добавить в кампанию;

-В открывшемся окне Содержимое уведомления заполнить необходимые поля и параметры:

1.Вкладка Содержание;

2. Заголовок уведомления - текстовое поле, есть возможность добавить эмоджи;

3. Текст уведомления - текстовое поле, есть возможность добавить эмоджи;

4. UTM - переключатель, который активирует специализированный параметр в URL, используемый маркетологами для отслеживания ресурсов, с которого передаётся трафик.

5. Название кампании (не обязательно) - текствовое поле, которое отображается если переключатель UTM активный;

6. Изменить иконку - дает возможность загрузить изображение с локального компьютера. Внесенные изменения сразу же отображаются на Предпросмотре.

7. Выберите часовой пояс рассылки - выпадающий список с возможностью поиска.

8. Летнее время - чекбокс, который учитывает наличие летнего времени для заданного часового пояса;

9. Предпросмотр - позволяет пользователю видеть внешний вид push’а для различных браузеров и операционных систем;

 

10. Дополнительные опции - вкладка с настройками кнопок push-уведомления;

11. Добавить большое изображение - дает возможность загрузить изображение с локального компьютера. Внесенные изменения сразу же отображаются на Предпросмотре;

12. Первая кнопка - переключатель, при активации которого есть возможность в push-уведомления добавить кнопку;

13. Название кнопки - текстовое поле, есть возможность вставить эмоджи. Внесенные изменения сразу же отображаются на Предсмотре;

14. Иконка кнопки - выпадающий список, есть возможность добавить эмоджи. При клике на кнопку Корзины иконка удаляется;

15. Ссылка кнопки - текстовое поле, принимает на вход только ссылки. При клике на кнопку в push-уведомлении будет перенаправлять подписчика на указанную ссылку;

16. UTM - переключатель, который активирует специализированный параметр в URL, используемый маркетологами для отслеживания ресурсов, с которого передаётся трафик;

17. Вторая кнопка - переключатель, активирующий блок настроек второй кнопки;

18. Блок настроек второй кнопки- поля и элементы, идентичны с 13-16;

19. Предпросмотр - позволяет пользователю видеть внешний вид push’а для различных браузеров и операционных систем, с учетом настроек кнопок;

20. Сохранить - при нажатии на кнопку сохраняется все изменения;

21. Отмена - всплывающее окно настроек содержимого уведомления закрывается, данные не сохраняются.

 

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

-Удалить запись;

-Редактировать;

-Изменить порядок записи в списке.

 

Push- серию при сохранении можно сразу же и активировать.

Сервис позволяет создать несколько серий, редактировать их, активировать/деактивировать и просмотреть информацию о завершенных сериях. Количественные показатели рассылок можно увидеть и на главной странице автоматизации.

 

При клике на кнопку История происходит редирект на Историю рассылок. В ней есть возможность увидеть запланированные отправки кампаний на ближайшие 24 часа.

(warning)На бесплатном тарифном плане система отправляет не более 5 автоматических push-кампаний в день. Чтобы отправлять более 5 автоматических push-кампаний в день, необходимо перейти на один из платных тарифов.

 

 

Push-digest

Push-digest

Сервис Gravitec.net позволяет автоматизировать формирование и рассылку push-дайджестов для подписчиков. Дайджест содержит в себе самые популярные/просматриваемые публикации(новости) за день и/или неделю.

  1. Активирование дайджеста

Чтобы активировать дайджесты, если этого не было сделано при создания учетной записи, необходимо:

-Выбрать пункт Автоматизация бокового меню сайта и нажать кнопку Активировать в блоке Push-дайджест;

 

После активации открывается страница с списком дайджестов. Страница имеет вид таблицы, которая имеет следующие поля и элементы:

 

  • Частота - периодичность рассылки дайджестов. Существует два вида рассылок: ежедневно и еженедельно;
  • День - показывает в какой именно день/дни недели происходит рассылка;
  • Время - показывает в котором часу начинает происходить рассылка;
  • Количество новостей - количество топ-новостей, которое будет иметь дайджест;
  • Период - промежуток времени, за который будет сформирован дайджест;
  • Статус - отображает статус данного типа дайджест. Существующие статусы дайджестов: Готов к созданию, Активно, Отключен; (заведу задачу чтобы окончания статусов были согласованы между собой)
  • + - кнопка Создать дайджест; (тоже необходимо синхронизовать переводы)
  • Предпросмотр тестового дайджеста - позволяет пользователю увидеть какой вид будет иметь push-дайджест.

 

Данный push можно открыть и увидеть дайджест. Если новостей недостаточно, будут отображаться заглушки новостей.

 

2. Создание дайджеста

При нажатии на кнопку +(Создать дайджест) открывается страница создания дайджестов. Страница имеет следующий вид:

На странице создания дайджеста доступны следующие параметры, поля и элементы:

  1. Тип дайджеста - доступны два типа: Из push-кампаний и Smart дайджест:

Из push-кампаний - Данный дайджест формируется на базе push-кампаний. Система выбирает за указанный период все push-кампании, определяет те, которые открывали саме чаще и формирует из них дайджест.

Smart дайджест - Отличается от первого типа тем что работает только при наличии активной RSS-ленты сайта и не включает в себя статьи, которые подписчик уже прочитал.

2. Дни недели - мультиселектор, позволяет указать дни в которые будет происходить рассылка дайджестов.

(warning)Для еженедельного дайджеста нет возможности выбрать больше одного дня.

3. Выбрать все - чек-бокс, при активации которого становятся выбраны все Дни недели.

(warning)Для еженедельного дайджеста данный чекбокс недоступен.

4. Время - селектор, дающий возможность указать время начала рассылки дайджеста.

 

5. Выберите часовой пояс рассылки - выпадающий список с возможностью поиска. Учитывается для параметра Время.

 

6. Количество новостей в дайджесте - выпадающий список в котором можно выбрать количество топ-новостей, с которых будет сформирован дайджест. Доступные значения - 6, 8 и 10 топ-новостей.

(warning)Если новостей/публикаций будет меньше чем в настройках, рассылка не будет отправлена.

(warning)Новости/публикации должны быть уникальными.

7. UTM статьи - переключатель, который активирует специализированный параметр в URL, используемый маркетологами для отслеживания рассылок. По умолчанию значения параметров

utm_source=”gravitec” и utm_medium=”push”.

8. Заголовок уведомления - текстовое поле, есть возможность вставить эмоджи. Внесенные изменения сразу же отображаются на Предсмотре.

9. Текст уведомления - текстовое поле, есть возможность вставить эмоджи. Внесенные изменения сразу же отображаются на Предсмотре.

10. UTM push уведомления - переключатель, который активирует специализированный параметр в URL, используемый маркетологами для отслеживания ресурсов, с которого передаётся трафик. По умолчанию значения параметров

utm_source=”gravitec” и utm_medium=”push”.

11. Изменить иконку - дает возможность загрузить и зображение с локального компьютера. Внесенные изменения сразу же отображаются на Предсмотре.

12. Предпросмотр - позволяет пользователю видеть внешний вид push’а для различных браузеров и операционных систем.

13. Примечания - дополнительная информация о типах дайджеста

14. Блок кнопок сохранения. Существует несколько вариантов сохранения внесенных данных:

  • Сохранить - сохранение всех внесенных изменений, но без активации дайджеста;
  • Сохранить и активировать - сохранение всех внесенных изменений и активации дайджеста;
  • Назад - возвращает на список дайджестов, изменения не сохраняются.

После внесения и сохранения всех данных страница создания дайджеста закрывается, параметры рассылки отображаются в таблице.

3. Просмотр, редактирование дайджестов

После создания дайджеста статус его меняется, доступны новые действия.

  1. Статус созданного дайджеста может иметь значения : Активно или Отключен. Если дайджест отключен, рассылки не будет происходить
  2. Кнопка редактирования. При нажатии открывается страница настроек дайджеста, где можно редактировать уже существующие параметры.
  3. Чек-бокс активации/деактивации дайджеста.

После создания push-дайджеста на главной странице автоматизации становится доступна История рассылок.

 

Website SDK

Website SDK Overview

To get Gravitec Push Notifications running on your website, follow these two steps.

Requirements

W3C Web Push Notifications are currently supported by Chrome 50+, Opera 42, Firefox 44+, Safari 7.0+, Yandex 16.3+.

This includes Chrome for Windows, Mac OSX, Linux, Chrome OS and Android. Chrome for iOS is not yet supported by Google.

 

Website SDK HTTPS Installation

Gravitec SDK Installation for Chrome websites (desktop + mobile)

Requirements

W3C Web Push Notifications are currently only supported by Chrome 42+

  • Includes Chrome for Windows, Mac OS X, Linux, Chrome OS, and Android. Chrome for iOS is not yet supported.

HTTP and HTTPS

If some of your pages are served via HTTP instead of HTTPS, then you will need to follow our HTTP Installation Guide instead.

If possible, we encourage you to migrate all your pages to HTTPS first, and then continue using this guide.

 

1. Download the SDK

1.1 Download the latest version of Gravitec Chrome Web SDK after the registration of your site in the Gravitec Dashboard.

1.2 Copy push-worker.js and manifest.json from gravitec_sdk_ directory and paste it into the top-level directory (root folder) of your site.

 

2. Include Required Files

2.1 Link https://cdn.gravitec.net/storage/APP_KEY/client.js and manifest.json to each page of your website by adding some code between <head> and </head> tags. Update APP_KEY with your Gravitec AppId. Most likely, you will have to do it just once in the file, which helps to generate a layout of the site. The resulting HTML should look like this:

<head>
 <script src="https://cdn.gravitec.net/storage/APP_KEY/client.js" async></script>
</head>

Now user will see a window asking for permission to receive notifications from your site immediately after opening the page:

doc-01.png

3. Customize Gravitec (Optional)

3.1 Your custom button or event.

Call Gravitec.push(["init"]) from a javascript file that is included in every page. Create or use your button and update YOUR_CUSTOM_BUTTON_ID with your button id.

The user will see a window asking for permission to receive notifications from your site immediately after clicking on the button.

You can create your own logic and call registerPush() method.

Important

You must keep all the SDK files together. https://cdn.gravitec.net/storage/APP_KEY/client.js, push-worker.js and manifest.json must be placed in the root directory of your site.

Link to https://cdn.gravitec.net/storage/APP_KEY/client.js must be added between <head> and </head> tags for every page on your website. Linking files this way allows us to be sure that: - any page can subscribe to notifications - any page can be opened from a notification (if set) - changes to the Google Registration id can be updated - session count can be accurately calculated.

That's It!

That’s it for now - the setup is complete. See our Web SDK API for more functions.

var Gravitec = Gravitec || [];
Gravitec.push(["init", {"autoRegister":false}]);
window.onload = function(){
 //Replace YOUR_CUSTOM_BUTTON_ID with your button id
 document.getElementById("YOUR_CUSTOM_BUTTON_ID").onclick = registerPush;
 function registerPush() {
  Gravitec.push(["registerUserForPush", function(success){
   if (success) {
    //your custom action
   }
  }]);
 }
}

Website SDK HTTP Installation

Gravitec SDK Installation for Chrome websites (desktop + mobile)

HTTP vs. HTTPS

This is the guide for using Google Chrome push notifications on websites that have some pages served via HTTP instead of HTTPS.

If you are sure that each page is served only via HTTPS, then you should follow Website SDK HTTPS Installation guide.

Requirements

W3C Web Push Notifications are currently only supported by Chrome 42+

  • Includes Chrome for Windows, Mac OS X, Linux, Chrome OS and Android. Chrome for iOS is not yet supported by Google.
 

1. Include Required GravitecSDK.js

1.1 Include https://cdn.gravitec.net/storage/APP_KEY/client.js in the the <head> HTML tag of each of your website pages. Update APP_KEY with your Gravitec AppId. The best way is to add it to the code that generates the layout for each of your webpages. The resulting HTML should look like this:

<head>
 <script src="https://cdn.gravitec.net/storage/c98ddb5b4e54032b1f012127a3c5aec3/client.js/" async></script>
</head>

2. Customize Gravitec (Optional)

2.1 Init with your custom button or event.

Call Gravitec.push(["init"]) from a javascript file that is included in every page. Create or use your button and update YOUR_CUSTOM_BUTTON_ID with your button id.

That's It!

That’s it for now - the setup is complete. See our Web SDK API for more functions.

var Gravitec = Gravitec || [];
Gravitec.push(["init", {"autoRegister":false}]);
window.onload = function() {
 //Replace YOUR_CUSTOM_BUTTON_ID with your button id
 document.getElementById("YOUR_CUSTOM_BUTTON_ID").onclick = registerPush;
 function registerPush() {
  Gravitec.push(["registerHttp");
 }
}

Website SDK API

JavaScript Async

The example assumes that you have the following code placed defined before calling Gravitec functions.

Update APP_KEY with your Gravitec AppId.

<script src="https://cdn.gravitec.net/storage/APP_KEY/client.js" async></script>
<script>var Gravitec= Gravitec || [];</script>
Functions

init

This is the only required method that you need to call for setting up Gravitec to receive push notifications. Call it from each page of your site.

  • Parameters
  • JSON options
  • Boolean autoRegister (Optional) - Automatically show browser prompt to accept notifications. You can pass in "false" to delay this pop-up and then call registerUserForPush to prompt them later.
  • Boolean createButton (Optional) It creates a default button that generates a window for receipt of the notifications, which appears after clicking.
  • String tooltipText (Optional, use only with createButton) - Default: "One click subscription to our newsletter!" Set the text that will be shown to users on a default button.

Example:

var Gravitec = Gravitec || [];
Gravitec.push(["init", {"autoRegister":false}]);

registerUserForPush

Call it when you want to prompt the user to accept push notifications. Only call if you set "false" in autoRegister: when called "init".

Example:

var Gravitec = Gravitec || [];
Gravitec.push(["registerUserForPush", callback]);

segmentation.addTag

The method tags a subscriber basing on on app event of your choice, so that later you will be able to create segments to target users with the tag. It is recommended to use addTags rather than addTag if you need to add more than one tag in one operation.

Parameters:

  • string value - set this to addTag.
  • string value - value to set – tag name.
  • Call back - set here call back to be fired when tag was successfully added and response from our server has been returned.
  • Call back - set here call back to be fired, when tag was not added or error.

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called when tag has been successfully added, second call back is called if some error has occurred during a tag addition:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTag","Tag1", 
  function() {console.log("Tag has been added")}, 
  function(err) console.log(err.message)
}])

Example 2:

Call back is called when tag has been successfully added:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTag", "Tag1",
  function() {console.log("Tag has been added")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTag", "Tag1"
])

segmentation.addTags

Add provided tag(s) to subscriber’s tags. Thus, a push segment based on these tags could be created.

Parameters:

  • string value - set this to addTags.
  • Array of strings - JSON array of string value(s) – tag(s) to add.
  • Call back - set here call back to be fired when tag was successfully added and response from our server has been returned.
  • Call back - set here call back to be fired when tag was not added or error occured

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called if tags have been successfully added, second call back is called if error has occurred during tags addition:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTags", [“new”,”new1”,”new2”], 
  function() {console.log("Tags has been added")}, 
  function(err){console.log(err.message)
}])

Example 2:

Call back is called if tags have been successfully added:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTags",[“new”,”new1”,”new2”],
  function() {console.log("Tags has been added")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.addTags", [“new”,”new1”,”new2”]
])

segmentation.setTags

Clear all existing user tags and set new tags for the user.

Parameters:

  • string value - set this to setTags.
  • Array of strings - JSON array of string value(s) – tag(s) to set.
  • Call back - set here call back that to be fired when tag was successfully added and response from our server has been returned.
  • Call back - set here call back to be fired when tag was not added or error occured.

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called if tags have been successfully set, second call back is called if error has occurred during tags setting:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setTags", ["value1", "value2"], 
  function() {console.log("Tags has been set")}, 
  function(err){console.log(err.message)
}])

Example 2:

Call back is called if tags have been successfully set:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setTags",["value1", "value2"], 
  function() {console.log("Tags has been set")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setTags", ["value1", "value2"]
])

segmentation.removeTag

The method deletes a provided tag that was previously set for a user with addTag, addTags or setTags. Use removeAllTags if you need to delete all user’s tags.

Parameters:

  • string value - set this to removeTag.
  • string value - tag name to be removed.
  • Call back - set here call back that to be fired when tag was successfully added and response from our server has been returned.
  • Call back - set here call back that to be fired, when tag was not added or error.

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called if tag has been successfully removed, second call back is called if error has occurred during a tag removal:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeTag", "value", 
  function() {console.log("Tag has been removed")}, 
  function(err){console.log(err.message)
}])

Example 2:

Call back is called if tag has been successfully removed:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeTag ","value", 
  function() {console.log("Tag has been removed")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeTag ", "value"
])

segmentation.removeAllTags

The method deletes all user’s tags that were previously set for a user with addTag, addTags or setTags.

Parameters:

  • string value - set this to removeAllTag.
  • Call back - set here call back to be fired, when tag was successfully added and response from our server has been returned.
  • Call back - set here call back to be fired, when tag was not added or error.

When error is encountered, err object is returned:

{ 
  error: true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called if all tags have been successfully removed, second call back is called if error has occurred during tags removal:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeAllTags",  
  function() {console.log("All tags has been removed")}, 
  function(err){console.log(err.message)
}])

Example 2:

Call back is called if all tags have been successfully removed:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeAllTags",  
  function() {console.log("All tags has been removed")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.removeAllTags"
])

getTags

Returns list of tag objects, associated with a subscriber.

Code:

 

var Gravitec = Gravitec|| [];
Gravitec.push(["getTags", callback]);

Example:

This code prints an array of the subscriber’s tags.

Gravitec.push(['getTags', function(tags) {
  var newArray = [];
  tags.map((tag)=>newArray.push(tag.name));
  console.log(newArray);
}])

segmentation.setAlias

Set an alias(user identifier) for subscriber to target the one.

Parameters:

  • string value - set this to setAlias.
  • string value - value to set – alias name.
  • Call back - set here call back to be fired, when tag was successfully added and response from our server has been returned.
  • Call back - set here call back to be fired, when tag was not added or error.

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

First call back is called if alias has been successfully set, second call back is called if some error has occurred during alias setting:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setAlias", "value", 
  function() {console.log("Alias has been set")}, 
  function(err){console.log(err.message)
}])

Example 2:

Call back is called if alias has been successfully set:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setAlias","value", 
  function() {console.log("Alias has been set")
}])

Example 3:

Without call back functions:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "segmentation.setAlias", "value" 
])

getSubscriptionData

To get visitor’s subscription detail such as subscription status, REGid, permission status and browser use this method. The method returns a subscription object in a resolved promise.

Parameters:

  • string value - set this to getSubscriptionData.
  • Call back - set here call back to be fired, when subscription data have been successfully fetched, data object contains subscription details.
  • Call back - set here call back to be fired, when an error occurred.

When error is encountered, err object is returned:

{ 
  error:true,  
  message: 'something went wrong' 
}

Example 1:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "getSubscriptionData", function(data) {
    console.log(data.permission); 
    console.log(data.subscription); 
    if(data.subscription) { 
      console.log(data.subscription.regID); 
    }
  }, function(err) {
    console.log(err.message);
  }
]) 

afterSubscription

Callback that is called after the device is successfully registered with Gravitec. Return token.

 

Example:

var Gravitec = Gravitec || [];
Gravitec.push(["afterSubscription", function (token) {
  console.log(token);
  //Your action
}]);

subscriptionResult

The method fires a callback after visitor interacted with subscription prompt. Visitor can press Allow, Block or just close the prompt in all these cases the method returns a relevant data.

Parameters:

  • string value - set this to subscriptionResult.
  • Call back - set here call back to be fired, when visitor press Allow, Block or closed the prompt, data object contains subscription details.
  • Call back - set here call back to be fired, when an error occurred.

When error is encountered, err object is returned:

{ 
error:true,  
message: 'something went wrong' 
}

Example 1:

var Gravitec = Gravitec || []; 
Gravitec.push([
  "subscriptionResult", function(data) {
    console.log(data.permission); 
    console.log(data.subscription); 
    if(data.subscription) { 
    console.log(data.subscription.regID); 
    }
  }, function(err){
    console.log(err.message);
  }
]) 

getSubscription

Lets you retrieve the Google Registration ID. Your handler is called after the device is successfully registered with Gravitec.

Example:

var Gravitec = Gravitec || [];
Gravitec.push(["getSubscription", function (subscriptionId) {
  if (subscriptionId) {
    console.log(subscriptionId);
  }
}]);

isSubscribed

Shows if user give permission to send notifications. Return true or false.

Example:

var Gravitec = Gravitec || [];
Gravitec.push(["isSubscribed", function (success) {
  console.log(success);
  //Your action
}]);

Generating your own GCM Push Notification Key

STEP 1: Create a Google Project and save the "Project Number"

1.1 Create a project at https://console.developers.google.com/project for your app.

doc-02.png

1.2 Select your Project and go to IAM & admin->Settings. Your project number should be located on this page.

Copy the "Project Number" from this page.

You will need to add it to the source code of your app later when you follow the SDK guide.

doc-03.png
STEP 2: Turn on "Google Cloud Messaging" API

2.1 Under APIs & Services>Library, search for "Google Cloud Messaging". Turn it on.

doc-04.png
STEP 3: Create and save Server Key

3.1 Under "APIs & services" > "Credentials", click "Create credentials".

 

3.2 Select "API key"

doc-05.png

3.3 Press the "Create" button.

IMPORTANT

DO NOT enter anything into the box.

 

3.4 Go to https://console.firebase.google.com and import your google project

doc-06.png

3.5 Click to "Project overview settings" and choose "CLOUD MESSAGING" tab. Copy Server Key.

doc-07.png
STEP 4: Send your GCM credentials to Gravitec support

4.1 Send your Project Number(Sender ID) and GCM Server key to support@gravitec.net.

 

Generating your own Safari Push Notification Certificate

The goals of this section are to provision your app with Apple and grant Gravitec access to manage your notifications.

1. Create Certificate Signing Request

1.1 Open Keychain Access on your Mac (it is located in Applications/Utilities) and choose the menu option Request a Certificate from a Certificate Authority….

doc-08.png

1.2 Save Certificate

You should now see the following window (pic. 1).

Enter your email address here. Some people recommend using the same email address that you used to sign up for the iOS Developer Program, but it seems to accept any email address just fine.

Check Saved to disk and click Continue.

doc-09.png

pic. 1

2. Create Website Push ID and apply the Certification Request to generate Certificate

2.1 Press "plus" button on the Website Push IDs.

doc-10.png

2.2 Enter an ID, a Description and press the button Continue.

doc-11.jpg

2.3 On the next pages press Register and the Done buttons.

 

2.4 On the Website Push IDs page select your site and press Edit.

doc-12.png

2.5 Press Create Certificate.

doc-13.png

2.6 Press "Choose File..", select the "certSigningRequest" file you saved in Step 1, open, and then press "Generate".

doc-14.png

2.7 Press "Download" to save your certificate

doc-15.png
3. Creating a p12 File

3.1 Open the website_aps_production.cer file you downloaded in the last step by double clicking on it in Finder.

doc-16.png

3.2 After a few seconds the "Keychain Access" program should pop up. Select Login > Keys, then right click on your key in the list and select "Export"

doc-17.png

3.3 Give name the .p12 file the same as sertificate ID (example: "web.net.0000001.gravitec"). You will have an option to protect the file with a password. Generating safari ID set the password "1111"!

 

4. Send your p12 file to Gravitec support (support@gravitec.net)

 

Server API

Server API Overview

About API

Our API is a REST API, which supports HTTP error codes to indicate API errors and use basic HTTP authentication to authenticate user’s account. All requests body must be in JSON format, we do not support other formats. However, we’re open-minded team and we are opened for any suggestions on formats or API logic. Please, write us support@gravitec.net if you have got any suggestions or issues with the API.

In addition to the REST API we provide to our clients WEB SDK API, which is essentially a JavaScript API designed to manage your subscriber’s database. For example, this SDK provides functions for tagging and setting aliases to your subscribers. Those tags and aliases could be useful for marketing purposes, such as – segmentation of subscribers’ database by their behavior or by their preferences.

Authentication

Authenticate your account when using the API by including your APP KEY and APP SECRET keys in the request. You can find your APP keys in the Site Settings page.

Your APP key allows to send push messages to all your subscribers database, so be careful and keep them in secret!

Authentication to the APP is performed via HTTP Basic Auth:

  • Provide your application key ("APP_KEY") as the basic AUTH username value
  • Provide your application secret ("APP_SECRET") as the basic AUTH password value
  • All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Code example:

// via shell
// example APP_KEY = 1e26f7bb3f81e1ab789d3e20b9cf6325
// example APP_SECRET = 9bb59fcbff38b85647c421c65cca06ce
curl -X \
  -u "1e26f7bb3f81e1ab789d3e20b9cf6325:9bb59fcbff38b85647c421c65cca06ce" \
  -H "Content-Type: application/json" \
  https://uapi.gravitec.net/api/v3/push

// or
curl -X \
  -u "1e26f7bb3f81e1ab789d3e20b9cf6325:9bb59fcbff38b85647c421c65cca06ce" \
  -H "Content-Type: application/json" \
  https://uapi.gravitec.net/api/v3/push

Send Push Notification V3

Set alias for subscriber V3

Definition

Method: POST

Endpoint: https://uapi.gravitec.net/api/v3/alias

Request parameters:

  • regId - subscriber’s token [Required, 1-255 symbols string]
  • name - desired alias name [Required, 1-255 symbols string]

NOTE: All request parameters names and values are case-sensitive.

Request URL example:

https://uapi.gravitec.net/api/v3/alias?regId=someregid&name=newalias
Responses

200 OK

The alias was successfully added

400 Required String parameter "name" is not present

"name" parameter was not provided in request

400 Required String parameter "regId" is not present

"regId" parameter was not provided in request

422 Unprocessable Entity

No follower with regID provided was found

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "There is no follower with this regId!"
}

422 Unprocessable Entity

Provided alias name length was more than 255 symbols

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "Max alias length is 255!"
}
Set Tag for subscriber V3

Definition

Method: POST

Endpoint: https://uapi.gravitec.net/api/v3/tag

Request parameters:

  • regId - subscriber’s token [Required, 1-255 symbols string]
  • name - desired tag name [Required, 1-255 symbols string]

NOTE: All request parameters names and values are case-sensitive.

NOTE: Tags saving method behaves with case sensitive values like:

First tag will be saved in exact case it provided, if another tag, which in case-insensitive comparison is the same one, provided, it will not be added as a new tag – the system considers it as the same as previous.

Request URL example:

https://uapi.gravitec.net/api/v3/tag?regId=someregid&name=tagname
Responses

200 OK

Tag was successfully added

400 Required String parameter "name" is not present

"name" parameter was not provided in request

400 Required String parameter "regId" is not present

"regId" parameter was not provided in request

422 Unprocessable Entity

No follower with regID provided was found

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "There is no follower with this regId!"
}

422 Unprocessable Entity

Provided tag name length was more than 255 symbols

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "Max alias length is 255!"
}

Delete subscriber’s tag V3

Definition

Method: DELETE

Endpoint: https://uapi.gravitec.net/api/v3/tag

Request parameters:

  • regId - subscriber’s token [Required, 1-255 symbols string]
  • name - desired tag name [Required, 1-255 symbols string]

NOTE: All request parameters names and values are case-sensitive.

Request URL example:

https://uapi.gravitec.net/api/v3/tag?regId=someregid&name=tagname
Responses

200 OK

Tag was successfully deleted

400 Required String parameter "name" is not present

"name" parameter was not provided in request

400 Required String parameter "regId" is not present

"regId" parameter was not provided in request

422 Unprocessable Entity

No follower with regID provided was found

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "There is no follower with this regId!"
}

422 Unprocessable Entity

Provided tag was not found for the subscriber with provided regId.

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "The follower doesn't have this tag!"
}

422 Unprocessable Entity

Provided tag name length was more than 255 symbols

Body:

{
  "httpStatus": "UNPROCESSABLE_ENTITY",
  "error": "Incomplete by wrong param(s)!",
  "errorDescription": "Max alias length is 255!"
}

Get subscriber’s alias V3

Definition

Method: GET

Endpoint: https://uapi.gravitec.net/api/v3/alias

Request parameters:

  • regId - subscriber’s token [Required, 1-255 symbols string]

NOTE: All request parameters names and values are case-sensitive.

Request URL example:

https://uapi.gravitec.net/api/v3/alias?regId=someregid
Responses

regIdExists [boolean]

  • Is "true" if provided in request regId is an actual subscriber’s token
  • Set in "false" if provided in request regId does not exists as actual subscriber’s token

aliasExists [boolean]

  • Is "true" if provided in request regId is an actual subscriber’s token and there is an active alias for that token
  • Is "false" if provided in request regId is an actual subscriber’s token and there is no active alias for that regID
  • Does not present in response if regIdExists is "false"

isActiveFollower [boolean]

  • Is "true" if provided in request regId is a token of an active subscriber
  • Is "false" if provided in request regId is a token of an inactive subscriber
  • Does not present in response if regIdExists is "false"

alias [string]

  • Is an actual and active alias for provided in request regId
  • Does not present in response if regIdExists is "false"

200 - OK

400 - Required String parameter regId is not present

 
Examples

RegId property was not in request

Request:

https://uapi.gravitec.net/api/v3/alias?regId=

Response code:

400 - Required String parameter regId is not present

RegId exists as actual subscriber’s token

Request:

https://uapi.gravitec.net/api/v3/alias?regId=okf8kj589ktGF5g3gF#gf3#46g^^6gfGfgfgfg%g5g

Response code:

200 - OK

Response body:

{
  "regIdExists": "false"
}

There is no active alias for regID

Request:

https://uapi.gravitec.net/api/v3/alias?regId=okf8kj589ktGF5g3gF#gf3#46g^^6gfGfgfgfg%g5g

Response code:

200 - OK

Response body:

{
  "regIdExists": "true",
  "aliasExists": "false",
  "isActiveFollower": "true"
}

There is an active alias for regID and subscriber is not in an active state

Request:

https://uapi.gravitec.net/api/v3/alias?regId=okf8kj589ktGF5g3gF#gf3#46g^^6gfGfgfgfg%g5g

Response code:

200 - OK

Response body:

{
  "regIdExists": "true",
  "aliasExists": "true",
  "isActiveFollower": "false",
  "alias": "alias1"
}

There is an active alias for regID and subscriber is in an active state

Request:

https://uapi.gravitec.net/api/v3/alias?regId=okf8kj589ktGF5g3gF#gf3#46g^^6gfGfgfgfg%g5g

Response code:

200 - OK

Response body:

{
  "regIdExists": "true",
  "aliasExists": "true",
  "isActiveFollower": "true",
  "alias": "alias1"
}
Send Push Notification V3

Definition

Method: POST

Endpoint: https://uapi.gravitec.net/api/v3/push

Headers: Content-Type: application/json

Request body properties:

{
  "send_date": "",
  "ttl": "",
  "push_tag":"",
  "display_time": "",
  "is_transactional": "",
  "payload": {
    "message": "",
    "title": "",
    "icon": "",
    "image": "",
    "redirect_url": "",
    "buttons": [{
      "title": "",
      "url": ""
    }]
  },
  "audience": {
    "tokens": [""],
    "aliases": [""],
    "tags": [""],
    "tags_segment": [{""}]
  }
}
Properties

send_date

Optional

default: ""

type: String or Int

Date and time, when you want your push to be sent. For delayed push, you must set the desired date and time, which have to be in the future and for immediate sending set it to "now".

NOTE: Time must be in UNIX_TIME format, which is essentially the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970, minus the number of leap milliseconds that have taken place since then

Example:

"send_date": "" - immediate sending
"send_date": 1509058800000 – send push at 2017.Oct.26 23:00:00

ttl

Optional

default: 28800

type: Int

The number of seconds that a message may be stored if the user is not immediately available.

NOTE: The number must be in between 0 and 2 419 200

NOTE: Keep in mind that a TTL value of 0 means messages that can't be delivered immediately to users are discarded. However, because such messages are never stored, this provides the best latency for sending notification messages

Example:

"ttl ": 28800   - time-to-live is set to 8 hours

push_tag

Optional

type: String

Tags push campaign so that a comparative analysis among such tags may be available.

NOTE: A tag's length must be between 1 and 100 characters

Example:

"push_tag": "news" - tags a campaign with "news" tag

display_time

Optional

default: 60

type: Int

The number of seconds that a message will be displayed on participant’s screen

NOTE: If set in 0 – the message will be displayed until user clicks on it

NOTE: Maximum time is 2419200

 

is_transactional

Optional

default: false

type: boolean

Marks a push message as Transactional, thus the message will not be displayed in the main campaign history section of the web application (https://push.gravitec.net). Use this if you send a great deal of small messages, which are by itself contains transactional data like personal notifications for your users, reminders, etc.

NOTE: If omitted, false" value will be set for a push message

 

payload

Required

The "Payload" section is required, whereas some arguments within the section are not required.

 

message

Required

type: String

Text, which will be displayed as push message text

NOTE: Maximum length of the message is 1000 symbols.

Example:

"message": "Push message text"
doc-18.png

title

Optional

default: Title

type: String

Title or header of the message.

NOTE: Max length of title is 1000 symbols.

Example:

"header ": "Just another header"

Chrome:

doc-19.png

Firefox:

doc-20.png

icon

Required

type: String

URL of notification's icon. Sets the notification icon to specified image URL. Image must be at least 80x80 pixels and with 1:1 ratio. Pictures without that ratio will be resized with its aspect ratio and put on a white square.

NOTE: Provide correct URL, without spaces or tabs at the start and at the end of the URL and with ending .jpg, .jpeg or .png, otherwise the error will be fired.

NOTE: Maximum length of the URL is 1000 symbols.

NOTE: Providing "icon": "" will set the icon to default site icon, which can be set in the Site Settings page

Example:

"icon": "https://push.gravitec.net/img/gravitecBig.jpg"

1:1 aspect ratio and more than 80x80 on X and Y sides:

doc-21.png

1:1.2 aspect ratio and more than 80 on Y side:

doc-22.png

1.2:1 aspect ratio and more than 80 on X side:

doc-23.png

Less than 80x80 on X and Y sides:

doc-24.png

image

Optional

type: String

URL of big picture to display below the notification main body. For the best results provided image must be with 1.5:1 sides ratio and size at least 360x240 pixels.

NOTE: Provide correct URL, without spaces or tabs at the start and at the end of the URL and with ending .jpg, .jpeg or .png, otherwise the error will be fired

NOTE: Maximum length of the URL is 1000 symbols.

NOTE: Pictures, which are not in 1.5:1 ratio or less then 360x240 and will be resized according to their aspect ratio and put on top of a white image of 360x240 px

Different image processing examples:

1.5:1 aspect ratio and more or equal than 360x240 on X and Y sides accordingly:

doc-25.png

1:1.2 aspect ratio and more than 240 on Y side:

doc-26.png

1.2:1 aspect ratio and more than 360 on X side:

doc-27.png

Less than 360x240 on X and Y sides:

doc-28.png

redirect_url

Required

type: String

URL which will be opened in user’s browser if user clicks on the notification.

NOTE: Maximum length of the URL is 1000 symbols.

NOTE: Provide correct URL, without spaces or tabs at the start and at the end of the URL, otherwise the error will be fired.

Example:

"redirect_url": "http://yoursite.com/news"

buttons

Optional

Specify in this array one or two action buttons, which will be displayed below the notification main body:

Example:

doc-29.pngdoc-30.png

title

Required

type: String

Provide appropriate title for the button.

NOTE: Max length of title is 48 symbols

 

url

Required

type: String

URL which will be opened in user’s browser if user clicks on the notification.

NOTE: Maximum length of the URL is 1000 symbols.

NOTE: Provide correct URL, without spaces or tabs at the start and at the end of the URL (rfc3986)

 

audience

Optional

The "Audience" section is optional.

NOTE: If omitted, the system shall send push message to all subscribers.

NOTE: If set - the section must contain only one of these variables (in other case, error will be fired):

 

tokens

Optional

type: Array

Specifying a list of subscribers’ IDs in this parameter means that message will be send exactly to the list of subscribers specified. You can get subscriber’s ID by using getSubscription function from our Web SDK API.

NOTE: Array size is limited to 100 IDs.

Example:

"tokens": ["dec301908b9ba...8df85e57a58e40f96f", "523f4c2068674f1fe...2ba25cdc250a2a41"]

aliases

Optional

type: Array

Specifying a list of aliases means that message will be sent exactly to the list of subscribers who are associated with aliases provided in the list. You can set an alias by using setAlias function from our Web SDK API.

Example:

"aliases": ["own_id_device_1", "own_id_device_2", "own_id_device_3"]

tags

Optional

type: Array

Specifying a list of tags means that message will be send exactly to the list of subscribers who were tagged with tags provided in the list. You can tag your subscribers by using addTag or setTags function from our Web SDK API.

Example:

"tags": ["tag1", "tag2", "tag3"]

tags_segment

Optional

type: Array

In order to send campaign to a part of your audience, which is an intersection two or more segments of tagged subscribers, you can provide such a condition by using logic operators AND, AND_NOT, OR, OR_NOT followed by a tag. Such conditions should be put in array of json elements.

AND – include all followers tagged by the tag followed with AND logical operator

AND_NOT - include all followers who hasn’t been tagged by the tag followed with AND logical operator

OR - include all followers tagged by the tag followed with OR logical operator

OR_NOT - include all followers who hasn’t been tagged by the tag followed with OR logical operator

NOTE: Tags array must contain not less that 1 and not more than 256 elements

NOTE: Tag name must contain not less that 1 and not more than 255 symbols

NOTE: You must provide logical operator only from the list: AND, AND_NOT, OR, OR_NOT

NOTE: Tag name provided must be case-insensitive unique among the elements in the array (Example: CARS and cars are not unique)

NOTE: It is not allowed to use both tags_segment and tags directive simultaneously

NOTE: You must provide tags that exists in the system

Example:

The system shall send the campaign to all followers with tag tag1 and without tag2:

"tags_segment": [{
  "association": "AND",
  "name": "tag1"
}, {
  "association": "AND_NOT",
  "name": "tag2"
}]

The system shall send the campaign to all followers without tag tag1 or with tag2:

"tags_segment": [{
  "association": "AND_NOT",
  "name": "tag1"
},{
  "association": "OR",
  "name": "tag2"
}]
Responses (Results and Errors)

200 OK - Standard response for successful HTTP requests

Request

{
  "payload": {
    "message": " Test massage",
    "title": "Test message",
    "redirect_url": "https://gravitec.net"
  }
}

Response

{
  "id": "1590394828308348928",
  "send_date": "1516718700678",
  "ttl": 86400,
  "display_time": 60,
  "payload": {
    "title": "Test message"
  }
}

403 FORBIDDEN - authorization failed

Request

POST /api/v3/push HTTP/1.1
Host: api.gravitec.net
Content-Type: application/json
Authorization: Basic Z2hqZ2hqZ2g6aGdtamdoag==
Cache-Control: no-cache

{
  "payload": {
    "message": "Test massage",
    "title": "Test message",
    "redirect_url": "https://gravitec.net"
  }
}

Response

{
  "status": "incomplete by bad auth",
  "error_message": "There is no web site with appKey: 5459059059405940gpgkj"
}
Get push Notification stats

Definition

Method: GET

Endpoint: https://uapi.gravitec.net/api/v3/messages/

Request parameters:

  • campaignID - Campaign ID [Required, Id from “Send Push Notification V3]

NOTE: All request parameters names and values are case-sensitive.

Request URL example:

https://uapi.gravitec.net/api/v3/messages/1603861504654835713
Responses

200 OK

The alias was successfully added

400 Required parameter "campaignID" is not present

"campaignID" parameter was not provided in request

422 Unprocessable Entity

No Push Campaign with campaignID provided was found

Body:

{
"httpStatus": "UNPROCESSABLE_ENTITY", 
"error": "Incomplete by wrong param(s)!", 
"errorDescription": "There is no message with this id!"
}