Кампании

Получить все

Конечная точка

GET https://pushye.com/api/campaigns/

Пример

curl --request GET \
--url 'https://pushye.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \

Параметры	Детали	Описание
search	Необязательный Строка	Строка поиска.
search_by	Необязательный Строка	По какому полю вы ищете? Разрешенные значения: `name`, `title`, `description`, `url`.
status	Необязательный Строка	Разрешенные значения: `draft`, `scheduled`, `processing`, `sent`
website_id	Необязательный Целое число
datetime_field	Необязательный Строка	Разрешенные значения: `datetime`, `scheduled_datetime`, `last_sent_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	Необязательный Строка	По какому полю отсортировать результаты. Разрешенные значения: `campaign_id`, `datetime`, `last_datetime`, `scheduled_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": "Sample message",
            "description": "This is coming from the API.",
            "url": "https://example.com",
            "image_url": null,
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
                "ttl": 2419200,
                "urgency": "normal",
                "is_silent": 0,
                "is_auto_hide": 0,
                "button_title_1": "",
                "button_url_1": "",
                "button_title_2": "",
                "button_url_2": ""
            },
            "subscribers_ids": [
                1,2,3,4,5
            ],
            "sent_subscribers_ids": [],
            "total_sent_push_notifications": 0,
            "total_push_notifications": 1,
            "total_displayed_push_notifications": 0,
            "total_clicked_push_notifications": 0,
            "total_closed_push_notifications": 0,
            "status": "draft",
            "scheduled_datetime": "2024-08-09 00:16:22",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-06-12 23:44:17",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushye.com/api/campaigns?page=1",
        "last": "https://pushye.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/campaigns?page=1"
    }
}

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

Конечная точка

GET https://pushye.com/api/campaigns/{campaign_id}

Пример

curl --request GET \
--url 'https://pushye.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \

Пример ответа

{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Sample message",
        "description": "This is coming from the API.",
        "url": "https://example.com",
        "image_url": null,
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
            "ttl": 2419200,
            "urgency": "normal",
            "is_silent": 0,
            "is_auto_hide": 0,
            "button_title_1": "",
            "button_url_1": "",
            "button_title_2": "",
            "button_url_2": ""
        },
        "subscribers_ids": [
            1,2,3,4,5
        ],
        "sent_subscribers_ids": [],
        "total_sent_push_notifications": 0,
        "total_push_notifications": 1,
        "total_displayed_push_notifications": 0,
        "total_clicked_push_notifications": 0,
        "total_closed_push_notifications": 0,
        "status": "draft",
        "scheduled_datetime": "2024-08-09 00:16:22",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-06-12 23:44:17",
    }
}

Параметры	Детали	Описание
website_id	Обязательно Целое число	-
name	Обязательно Строка	-
title	Обязательно Строка	-
description	Обязательно Строка	-
url	Необязательный Строка	-
image	Необязательный Файл	-
button_title_1	Необязательный Строка	-
button_url_1	Необязательный Строка	-
button_title_2	Необязательный Строка	-
button_url_2	Необязательный Строка	-
is_scheduled	Необязательный Булевый	-
scheduled_datetime	Необязательный Строка	-
is_silent	Необязательный Булевый	-
is_auto_hide	Необязательный Булевый	-
ttl	Необязательный Строка	Разрешенные значения: `0`, `900`, `1800`, `3600`, `10800`, `21600`, `43200`, `86400`, `259200`, `432000`, `604800`, `1209600`, `2419200`
segment	Необязательный Строка	Разрешенные значения: `all`, `custom`, `filter`, `INT segment_id`
subscribers_ids	Необязательный Строка	Доступно когда: segment = custom
filters_custom_parameter_key[index]	Необязательный Строка	Доступно когда: segment = filter
filters_custom_parameter_condition[index]	Необязательный Строка	Разрешенные значения: `exact`, `not_exact`, `contains`, `not_contains`, `starts_with`, `not_starts_with`, `ends_with`, `not_ends_with`, `bigger_than`, `lower_than Доступно когда: segment = filter`
filters_custom_parameter_value[index]	Необязательный Строка	Доступно когда: segment = filter
filters_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_seen_online_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_seen_online_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_sent_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_sent_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_subscribed_on_url	Необязательный Строка	Доступно когда: segment = filter
filters_cities	Необязательный Строка	Доступно когда: segment = filter
filters_countries[]	Необязательный Строка	Доступно когда: segment = filter
filters_continents[]	Необязательный Строка	Доступно когда: segment = filter
filters_device_type[]	Необязательный Строка	Доступно когда: segment = filter
filters_languages[]	Необязательный Строка	Доступно когда: segment = filter
filters_operating_systems[]	Необязательный Строка	Доступно когда: segment = filter
filters_browsers[]	Необязательный Строка	Доступно когда: segment = filter
utm_source	Необязательный Строка	-
utm_medium	Необязательный Строка	-
utm_campaign	Необязательный Строка	-
save	Необязательный Булевый	Сохранить черновик
send	Необязательный Булевый	Отправить кампанию

curl --request POST \
--url 'https://pushye.com/api/campaigns' \
--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' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Обновить

Конечная точка

POST https://pushye.com/api/campaigns/{campaign_id}

Параметры	Детали	Описание
website_id	Необязательный Целое число	-
name	Необязательный Строка	-
title	Необязательный Строка	-
description	Необязательный Строка	-
url	Необязательный Строка	-
image	Необязательный Файл	-
button_title_1	Необязательный Строка	-
button_url_1	Необязательный Строка	-
button_title_2	Необязательный Строка	-
button_url_2	Необязательный Строка	-
is_scheduled	Необязательный Булевый	-
scheduled_datetime	Необязательный Строка	-
is_silent	Необязательный Булевый	-
is_auto_hide	Необязательный Булевый	-
ttl	Необязательный Строка	Разрешенные значения: `0`, `900`, `1800`, `3600`, `10800`, `21600`, `43200`, `86400`, `259200`, `432000`, `604800`, `1209600`, `2419200`
segment	Необязательный Строка	Разрешенные значения: `all`, `custom`, `filter`, `INT segment_id`
subscribers_ids	Необязательный Строка	Доступно когда: segment = custom
filters_custom_parameter_key[index]	Необязательный Строка	Доступно когда: segment = filter
filters_custom_parameter_condition[index]	Необязательный Строка	Разрешенные значения: `exact`, `not_exact`, `contains`, `not_contains`, `starts_with`, `not_starts_with`, `ends_with`, `not_ends_with`, `bigger_than`, `lower_than Доступно когда: segment = filter`
filters_custom_parameter_value[index]	Необязательный Строка	Доступно когда: segment = filter
filters_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_seen_online_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_seen_online_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_last_sent_datetime_condition	Необязательный Строка	Доступно когда: segment = filter `within_last`, `older_than`
filters_last_sent_datetime_value	Необязательный Целое число	Доступно когда: segment = filter дни
filters_subscribed_on_url	Необязательный Строка	Доступно когда: segment = filter
filters_cities	Необязательный Строка	Доступно когда: segment = filter
filters_countries[]	Необязательный Строка	Доступно когда: segment = filter
filters_continents[]	Необязательный Строка	Доступно когда: segment = filter
filters_device_type[]	Необязательный Строка	Доступно когда: segment = filter
filters_languages[]	Необязательный Строка	Доступно когда: segment = filter
filters_operating_systems[]	Необязательный Строка	Доступно когда: segment = filter
filters_browsers[]	Необязательный Строка	Доступно когда: segment = filter
utm_source	Необязательный Строка	-
utm_medium	Необязательный Строка	-
utm_campaign	Необязательный Строка	-
save	Необязательный Булевый	Сохранить черновик
send	Необязательный Булевый	Отправить кампанию

Пример

curl --request POST \
--url 'https://pushye.com/api/campaigns/{campaign_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' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Удалить

Конечная точка

DELETE https://pushye.com/api/campaigns/{campaign_id}

Пример

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

Кампании

Получить все

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

Создать

Обновить

Удалить