Campagnes

Récupérer la liste complète

GET https://pusher.meerabl.com/api/campaigns/
curl --request GET \
--url 'https://pusher.meerabl.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Facultatif Chaîne de caractères Chaîne de recherche.
search_by Facultatif Chaîne de caractères Champ dans lequel effectuer la recherche. Valeurs autorisées : name, title, description, url.
status Facultatif Chaîne de caractères Valeurs autorisées : draft, scheduled, processing, sent
website_id Facultatif Entier
datetime_field Facultatif Chaîne de caractères Valeurs autorisées : datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Facultatif Chaîne de caractères Filtrer les résultats à partir de cette date et heure. Format : Y-m-d H:i:s.
datetime_end Facultatif Chaîne de caractères Filtrer les résultats jusqu'à cette date et heure. Format : Y-m-d H:i:s.
order_by Facultatif Chaîne de caractères Champ utilisé pour trier les résultats. Valeurs autorisées : 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 Facultatif Chaîne de caractères Sens du tri. Valeurs autorisées : ASC pour un ordre croissant et DESC pour un ordre décroissant.
page Facultatif Entier Numéro de la page à récupérer. Valeur par défaut : 1.
results_per_page Facultatif Entier Nombre de résultats souhaité par page. Valeurs autorisées : 10, 25, 50, 100, 250, 500, 1000. Valeur par défaut : 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-11-14 16:05:23",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pusher.meerabl.com/api/campaigns?page=1",
        "last": "https://pusher.meerabl.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://pusher.meerabl.com/api/campaigns?page=1"
    }
}

Récupérer un élément

GET https://pusher.meerabl.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pusher.meerabl.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-11-14 16:05:23",
    }
}

Créer

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

Mettre à jour

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