Campagnes

Récupérer tout

GET https://pushye.com/api/campaigns/
curl --request GET \
--url 'https://pushye.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Optionnel Chaîne La chaîne de recherche.
search_by Optionnel Chaîne Quel champ recherchez-vous ? Les valeurs autorisées sont : name, title, description, url.
status Optionnel Chaîne Valeurs autorisées : draft, scheduled, processing, sent
website_id Optionnel Entier
datetime_field Optionnel Chaîne Valeurs autorisées : datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Optionnel Chaîne Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Optionnel Chaîne Filter results up to this datetime. Y-m-d H:i:s format.
order_by Optionnel Chaîne Quel champ pour trier les résultats. Les valeurs autorisées sont : 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 Optionnel Chaîne L'ordre des résultats. Les valeurs autorisées sont : ASC pour un ordre croissant, et DESC pour un ordre décroissant.
page Optionnel Entier Le numéro de page dont vous souhaitez obtenir les résultats. Par défaut, c'est 1.
results_per_page Optionnel Entier Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. Par défaut, c'est 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-04-28 18:38:39",
        }
    ],
    "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"
    }
}

Récupérer un

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-04-28 18:38:39",
    }
}

Créer

POST https://pushye.com/api/campaigns
Paramètres Détails Description
website_id Requis Entier -
name Requis Chaîne -
title Requis Chaîne -
description Requis Chaîne -
url Optionnel Chaîne -
image Optionnel Fichier -
button_title_1 Optionnel Chaîne -
button_url_1 Optionnel Chaîne -
button_title_2 Optionnel Chaîne -
button_url_2 Optionnel Chaîne -
is_scheduled Optionnel Booléen -
scheduled_datetime Optionnel Chaîne -
is_silent Optionnel Booléen -
is_auto_hide Optionnel Booléen -
ttl Optionnel Chaîne Valeurs autorisées : 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Optionnel Chaîne Valeurs autorisées : all, custom, filter, INT segment_id
subscribers_ids Optionnel Chaîne Disponible quand : segment = custom
filters_custom_parameter_key[index] Optionnel Chaîne Disponible quand : segment = filter
filters_custom_parameter_condition[index] Optionnel Chaîne Valeurs autorisées : exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible quand : segment = filter
filters_custom_parameter_value[index] Optionnel Chaîne Disponible quand : segment = filter
filters_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_seen_online_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_seen_online_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_sent_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_sent_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_subscribed_on_url Optionnel Chaîne Disponible quand : segment = filter
filters_cities Optionnel Chaîne Disponible quand : segment = filter
filters_countries[] Optionnel Chaîne Disponible quand : segment = filter
filters_continents[] Optionnel Chaîne Disponible quand : segment = filter
filters_device_type[] Optionnel Chaîne Disponible quand : segment = filter
filters_languages[] Optionnel Chaîne Disponible quand : segment = filter
filters_operating_systems[] Optionnel Chaîne Disponible quand : segment = filter
filters_browsers[] Optionnel Chaîne Disponible quand : segment = filter
utm_source Optionnel Chaîne -
utm_medium Optionnel Chaîne -
utm_campaign Optionnel Chaîne -
save Optionnel Booléen Enregistrer le brouillon
send Optionnel Booléen Envoyer la campagne
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
    }
}

Mise à jour

POST https://pushye.com/api/campaigns/{campaign_id}
Paramètres Détails Description
website_id Optionnel Entier -
name Optionnel Chaîne -
title Optionnel Chaîne -
description Optionnel Chaîne -
url Optionnel Chaîne -
image Optionnel Fichier -
button_title_1 Optionnel Chaîne -
button_url_1 Optionnel Chaîne -
button_title_2 Optionnel Chaîne -
button_url_2 Optionnel Chaîne -
is_scheduled Optionnel Booléen -
scheduled_datetime Optionnel Chaîne -
is_silent Optionnel Booléen -
is_auto_hide Optionnel Booléen -
ttl Optionnel Chaîne Valeurs autorisées : 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Optionnel Chaîne Valeurs autorisées : all, custom, filter, INT segment_id
subscribers_ids Optionnel Chaîne Disponible quand : segment = custom
filters_custom_parameter_key[index] Optionnel Chaîne Disponible quand : segment = filter
filters_custom_parameter_condition[index] Optionnel Chaîne Valeurs autorisées : exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible quand : segment = filter
filters_custom_parameter_value[index] Optionnel Chaîne Disponible quand : segment = filter
filters_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_seen_online_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_seen_online_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_last_sent_datetime_condition Optionnel Chaîne Disponible quand : segment = filter within_last, older_than
filters_last_sent_datetime_value Optionnel Entier Disponible quand : segment = filter jours
filters_subscribed_on_url Optionnel Chaîne Disponible quand : segment = filter
filters_cities Optionnel Chaîne Disponible quand : segment = filter
filters_countries[] Optionnel Chaîne Disponible quand : segment = filter
filters_continents[] Optionnel Chaîne Disponible quand : segment = filter
filters_device_type[] Optionnel Chaîne Disponible quand : segment = filter
filters_languages[] Optionnel Chaîne Disponible quand : segment = filter
filters_operating_systems[] Optionnel Chaîne Disponible quand : segment = filter
filters_browsers[] Optionnel Chaîne Disponible quand : segment = filter
utm_source Optionnel Chaîne -
utm_medium Optionnel Chaîne -
utm_campaign Optionnel Chaîne -
save Optionnel Booléen Enregistrer le brouillon
send Optionnel Booléen Envoyer la campagne
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
    }
}

Supprimer

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