Перейти к содержанию

События

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/events/add?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/events/add?key=1234567890qwerty&project=12345
    

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

POST /project/events/meta/{i:eventId}/archive

C помощью этого метода можно добавить событие в архив.

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

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

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

[
    {
        "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 /project/events/add

С помощью данного метода можно добавить события списком.

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

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

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

[
    {
        "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 /project/events/log

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

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

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

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

{
    "name": "Test"
}

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

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

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

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

Параметр Тип Описание Обязательный
name 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 /project/events/send

С помощью данного метода можно отправлять события.

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

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

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

{
    "name": "Открытие формы",
    "visit": "100001",
    "data": {
        "region": "Москва",
        "landing": 1
    }
}
{
    "status": "success"
}

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

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

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

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

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

POST /project/events/bulk/send

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

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

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

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

[
    {
        "name": "Открытие формы",
        "visit": "100001",
        "data": {
            "region": "Москва",
            "landing": 1
        }
    },
    {
        "name": "Открытие формы",
        "visit": "100002",
        "data": {
            "region": "Москва",
            "landing": 1
        }
    }
]
{
    "status": "success"
}

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

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

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

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