Кампании

Получить все

GET https://nofas.ru/api/campaigns/
curl --request GET \
--url 'https://nofas.ru/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробности Описание
search Опционально Строка Строка поиска.
search_by Опционально Строка Поле для поиска. Допустимые значения: name, domain.
is_enabled Опционально Булево
datetime_field Опционально Строка Допустимые значения: 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, name, domain.
order_type Опционально Строка Направление сортировки. Допустимые значения: ASC (по возрастанию) и DESC (по убыванию).
page Опционально Целое Номер страницы. По умолчанию 1.
results_per_page Опционально Целое Результатов на странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "pixel_key": "Example",
            "name": "Example",
            "domain": "Example",
            "branding": {},
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2026-10-28 14:40:22",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-28 14:40:22"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://nofas.ru/api/campaigns?page=1",
        "last": "https://nofas.ru/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://nofas.ru/api/campaigns?page=1"
    }
}

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

GET https://nofas.ru/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://nofas.ru/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2026-10-28 14:40:22",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-28 14:40:22"
    }
}

Создать

POST https://nofas.ru/api/campaigns
Параметры Подробности Описание
domain_id Опционально Целое -
name Обязательно Строка -
domain Обязательно Строка -
branding_name Опционально Строка -
branding_url Опционально Строка -
email_reports Опционально Массив ID обработчиков уведомлений
is_enabled Опционально Булево -
curl --request POST \
--url 'https://nofas.ru/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": "Example",
        "email_reports_last_datetime": null,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-28 14:40:22"
    }
}

Обновить

POST https://nofas.ru/api/campaigns/{campaign_id}
Параметры Подробности Описание
domain_id Опционально Целое -
name Опционально Строка -
domain Опционально Строка -
branding_name Опционально Строка -
branding_url Опционально Строка -
email_reports Опционально Массив ID обработчиков уведомлений
is_enabled Опционально Булево -
curl --request POST \
--url 'https://nofas.ru/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2026-10-28 14:40:22",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-28 14:40:22"
    }
}

Удалить

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