Потоки

Получить все

GET https://pushye.com/api/flows/
curl --request GET \
--url 'https://pushye.com/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
search Необязательный Строка Строка поиска.
search_by Необязательный Строка По какому полю вы ищете? Разрешенные значения: name, title, description, url.
website_id Необязательный Целое число
datetime_field Необязательный Строка Разрешенные значения: last_sent_datetime, datetime, last_datetime
datetime_start Необязательный Строка Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Необязательный Строка Filter results up to this datetime. Y-m-d H:i:s format.
order_by Необязательный Строка По какому полю отсортировать результаты. Разрешенные значения: flow_id, datetime, last_datetime, last_sent_datetime, name, title, total_push_notifications, total_sent_push_notifications, total_displayed_push_notifications, total_clicked_push_notifications, total_closed_push_notifications.
order_type Необязательный Строка Порядок результатов. Разрешенные значения: ASC для восходящего порядка и DESC для нисходящего порядка.
page Необязательный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию 1.
results_per_page Необязательный Целое число Сколько результатов вы хотите на странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "name": "Example",
            "title": "Example",
            "description": "Example",
            "url": "https://example.com/",
            "image_url": "https://example.com/",
            "segment": "Example",
            "settings": [],
            "wait_time": 1,
            "wait_time_type": "Example",
            "is_enabled": true,
            "total_sent_push_notifications": 1,
            "total_displayed_push_notifications": 1,
            "total_clicked_push_notifications": 1,
            "total_closed_push_notifications": 1,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-09-13 16:38:25"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://pushye.com/api/flows?page=1",
        "last": "https://pushye.com/api/flows?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/flows?page=1"
    }
}

Получить один

GET https://pushye.com/api/flows/{flow_id}
curl --request GET \
--url 'https://pushye.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": [],
        "wait_time": 1,
        "wait_time_type": "Example",
        "is_enabled": true,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-13 16:38:25"
    }
}

Создать

POST https://pushye.com/api/flows
Параметры Детали Описание
website_id Обязательно Целое число -
name Обязательно Строка -
title Обязательно Строка -
description Обязательно Строка -
url Необязательный Строка -
image Необязательный Файл -
wait_time Обязательно Целое число -
wait_time_type Обязательно Строка Разрешенные значения: minutes, hours, days
trigger_type Необязательный Строка Разрешенные значения: subscription, pageview
pageview_trigger_condition Необязательный Строка Разрешенные значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with
pageview_trigger_value Необязательный Строка -
cancel_pageview_is_enabled Необязательный Булевый -
cancel_pageview_condition Необязательный Строка Разрешенные значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with
cancel_pageview_value Необязательный Строка -
cooldown_type Необязательный Строка Разрешенные значения: none, once, time
cooldown_time Необязательный Целое число -
cooldown_time_type Необязательный Строка Разрешенные значения: minutes, hours, days
button_title_1 Необязательный Строка -
button_url_1 Необязательный Строка -
button_title_2 Необязательный Строка -
button_url_2 Необязательный Строка -
is_silent Необязательный Булевый -
is_auto_hide Необязательный Булевый -
ttl Необязательный Строка Разрешенные значения: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
utm_source Необязательный Строка -
utm_medium Необязательный Строка -
utm_campaign Необязательный Строка -
segment Необязательный Строка Разрешенные значения: all, INT segment_id
is_enabled Необязательный Булевый -
auto_apply_to_matching Необязательный Булевый -
urgency Необязательный Целое число -
curl --request POST \
--url 'https://pushye.com/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": {},
        "wait_time": "Example",
        "wait_time_type": "Example",
        "is_enabled": true,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-13 16:38:25"
    }
}

Обновить

POST https://pushye.com/api/flows/{flow_id}
Параметры Детали Описание
website_id Необязательный Целое число -
name Необязательный Строка -
title Необязательный Строка -
description Необязательный Строка -
url Необязательный Строка -
image Необязательный Файл -
wait_time Необязательный Целое число -
wait_time_type Необязательный Строка Разрешенные значения: minutes, hours, days
trigger_type Необязательный Строка Разрешенные значения: subscription, pageview
pageview_trigger_condition Необязательный Строка Разрешенные значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with
pageview_trigger_value Необязательный Строка -
cancel_pageview_is_enabled Необязательный Булевый -
cancel_pageview_condition Необязательный Строка Разрешенные значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with
cancel_pageview_value Необязательный Строка -
cooldown_type Необязательный Строка Разрешенные значения: none, once, time
cooldown_time Необязательный Целое число -
cooldown_time_type Необязательный Строка Разрешенные значения: minutes, hours, days
button_title_1 Необязательный Строка -
button_url_1 Необязательный Строка -
button_title_2 Необязательный Строка -
button_url_2 Необязательный Строка -
is_silent Необязательный Булевый -
is_auto_hide Необязательный Булевый -
ttl Необязательный Строка Разрешенные значения: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
utm_source Необязательный Строка -
utm_medium Необязательный Строка -
utm_campaign Необязательный Строка -
segment Необязательный Строка Разрешенные значения: all, INT segment_id
is_enabled Необязательный Булевый -
auto_apply_to_matching Необязательный Строка -
urgency Необязательный Целое число -
curl --request POST \
--url 'https://pushye.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": {},
        "wait_time": "Example",
        "wait_time_type": "Example",
        "is_enabled": true,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-13 16:38:25"
    }
}

Удалить

DELETE https://pushye.com/api/flows/{flow_id}
curl --request DELETE \
--url 'https://pushye.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \