캠페인

모두 검색하기

GET https://pushye.com/api/campaigns/
curl --request GET \
--url 'https://pushye.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
매개변수 세부사항 설명
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-03-11 15:37:32",
        }
    ],
    "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-03-11 15:37:32",
    }
}

생성하다

POST https://pushye.com/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_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_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}' \