Кампании

Получить все

GET https://pushda.ru/api/campaigns/
curl --request GET \
--url 'https://pushda.ru/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 Необязательный Строка Отфильтруйте результаты, начиная с этой даты-времени. Формат <код>Y-m-d H:i:s.
datetime_end Необязательный Строка Отфильтруйте результаты до этой даты-времени. Формат <код>Y-m-d H:i:s.
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-25 15:14:26",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushda.ru/api/campaigns?page=1",
        "last": "https://pushda.ru/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushda.ru/api/campaigns?page=1"
    }
}

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

GET https://pushda.ru/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pushda.ru/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-25 15:14:26",
    }
}

Создать

POST https://pushda.ru/api/campaigns
Параметры Подробности Описание
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://pushda.ru/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://pushda.ru/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://pushda.ru/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://pushda.ru/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://pushda.ru/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \