API Cобытий¶

Добавить событие в архив¶

POST https://cloud.roistat.com/api/v1/project/events/meta/{i:eventId}/archive

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Метод добавляет событие в архив.

curl 'https://cloud.roistat.com/api/v1/project/events/meta/{i:eventId}/archive?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '[{"display_name": "test1","type": "js","parameter": "js-12"}]'

Тело запроса:

[
    {
        "display_name": "test1",
        "type": "js",
        "parameter": "js-12"
    },
    {
        "display_name": "test2",
        "type": "url",
        "parameter": "http://test.com"
    }
]

Без параметров.

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Обязательный
display_name	string	нет
type	string	нет
parameter	string	нет

Параметр	Тип	Описание
type	string
properties	object
> events	object
>> type	string
>> items	object
>>> type	string
>>> properties	object
>>>> id	object
>>>>> type	string
>>>> display_name	object
>>>>> type	string
>>>> type	object
>>>>> type	string
>>>> parameter	object
>>>>> type	string
> status	object
>> type	string

Создать события¶

POST https://cloud.roistat.com/api/v1/project/events/add

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Метод добавляет события списком.

curl 'https://cloud.roistat.com/api/v1/project/events/add?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '[{"display_name": "test1","type": "js","parameter": "js-12"}]'

Тело запроса:

[
    {
        "display_name": "test1",
        "type": "js",
        "parameter": "js-12"
    },
    {
        "display_name": "test2",
        "type": "url",
        "parameter": "http://test.com"
    }
]

{
    "events": [
        {
            "id": "13",
            "display_name": "test1",
            "type": "js",
            "parameter": "js-12"
        },
        {
            "id": "14",
            "display_name": "test2",
            "type": "url",
            "parameter": "http://test.com"
        }
    ],
    "status": "success"
}

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Описание	Обязательный
display_name	string	название события	нет
type	string	js или url - определяет условие срабатывания события	нет
parameter	string	ID события или ссылка	нет

Параметр	Тип	Описание
events	array[object]
> id	string
> display_name	string
> type	string
> parameter	string
status	string

Получить данные по каждому событию из истории срабатываний¶

GET https://cloud.roistat.com/api/v1/project/events/log

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

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

curl 'https://cloud.roistat.com/api/v1/project/events/log?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"name": "Переход в корзину","date_from": "2022-04-04T20:59:59.999Z","date_to": "2022-05-04T15:00:00.000Z"}'

Тело запроса:

{
    "name": "Переход в корзину",
    "date_from": "2022-04-04T20:59:59.999Z",
    "date_to": "2022-05-04T15:00:00.000Z"
}

{
    "items": [
        {
            "id": "123",
            "display_name": "Переход в корзину",
            "parameter": "view_contacts_page",
            "type": "js",
            "event_date": "2022-04-04T23:51:58+0000",
            "data": null,
            "visit_id": "41599"
        },
        {
            "id": "456",
            "display_name": "Переход в корзину",
            "parameter": "cozy.home.ru/catalog/decor",
            "type": "url",
            "event_date": "2022-05-03T23:51:29+0000",
            "data": null,
            "visit_id": "41598"
        }
    ],
    "status": "success"
}

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Описание	Обязательный
name	string	Название события	нет
date_from	string	Дата, с которой учитывать срабатывания	нет
date_to	string	Дата, до которой учитывать срабатывания	нет

Параметр	Тип	Описание
items	array[object]
> id	string	ID срабатывания события
> display_name	string	Название события
> parameter	string	URL или ID события
> type	string	Условие срабатывания
> event_date	string	Дата срабатывания
> data	null или object	Дополнительные данные о срабатывании события
> visit_id	null или string
status	string

Отправить событие¶

POST https://cloud.roistat.com/api/v1/project/events/send

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Метод отправляет событие.

curl 'https://cloud.roistat.com/api/v1/project/events/send?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"name": "Название события", "visit": "100001", "data": {"region": "Москва", "landing": 1, "client": {"name": "Имя клиента", "phone": "Номер телефона", "email": "example@test.com"}}}'

Тело запроса:

{
    "name": "Название события",
    "visit": "100001",
    "data": {"region": "Москва",
             "landing": 1,
             "client": {"name": "Имя клиента", 
                        "phone": "Номер телефона", 
                        "email": "example@test.com"}
            }
}

{
    "status": "success"
}

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Описание	Обязательный
name	string	Название события, созданного в Roistat.	да
visit	string	Номер визита из куки roistat_visit.	нет
data	object	Дополнительные параметры события. Отображаются в Истории срабатываний в столбце «Доп.поля».	нет

Параметр	Тип	Описание
status	string

Отправить сразу несколько событий¶

POST https://cloud.roistat.com/api/v1/project/events/bulk/send

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Метод отправляет сразу несколько событий.

curl 'https://cloud.roistat.com/api/v1/project/events/bulk/send?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '[{"name": "Открытие формы","visit": "100001" "data": {"region": "Москва","landing": 1}}, {"name": "Регистрация", "visit": "100002", "data": {"client": "name": "Имя клиента", "phone": "Номер телефона", "email": "example@test.com"}}]'

Тело запроса:

[
    {
        "name": "Открытие формы",
        "visit": "100001",
        "data": {"region": "Москва",
                 "landing": 1}
    },
    {
        "name": "Регистрация",
        "visit": "100002",
        "data": {"client": {"name": "Имя клиента", 
                            "phone": "Номер телефона", 
                            "email": "example@test.com"}
                }
    }
]

{
    "status": "success"
}

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Описание	Обязательный
name	string	Название события, созданного в Roistat	нет
visit	string	Номер визита из куки roistat_visit	нет
data	object	Дополнительные параметры события (отображаются в Истории срабатываний в столбце «Доп.поля»)	нет

Параметр	Тип	Описание
status	string