Campagnes

Tout récupérer

GET https://wwidgets.com/api/campaigns/
curl --request GET \
--url 'https://wwidgets.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Facultatif Chaîne de caractères La chaîne de recherche.
search_by Facultatif Chaîne de caractères Le champ sur lequel porte la recherche. Valeurs autorisées : name, domain.
is_enabled Facultatif Booléen
datetime_field Facultatif Chaîne de caractères Valeurs autorisées : datetime, last_datetime
datetime_start Facultatif Chaîne de caractères Filtre les résultats à partir de cette date et heure. Format Y-m-d H:i:s.
datetime_end Facultatif Chaîne de caractères Filtre les résultats jusqu'à cette date et heure. Format Y-m-d H:i:s.
order_by Facultatif Chaîne de caractères Le champ servant à trier les résultats. Valeurs autorisées : campaign_id, datetime, last_datetime, name, domain.
order_type Facultatif Chaîne de caractères L'ordre de tri des résultats. Valeurs autorisées : ASC pour un tri croissant et DESC pour un tri décroissant.
page Facultatif Entier Le numéro de page dont vous souhaitez obtenir les résultats. Par défaut : 1.
results_per_page Facultatif Entier Le nombre de résultats souhaité par page. Valeurs autorisées : 10, 25, 50, 100, 250, 500, 1000. Par défaut : 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-16 16:46:51",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-16 16:46:51"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://wwidgets.com/api/campaigns?page=1",
        "last": "https://wwidgets.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://wwidgets.com/api/campaigns?page=1"
    }
}

Récupérer un élément

GET https://wwidgets.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://wwidgets.com/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-16 16:46:51",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:51"
    }
}

Créer

POST https://wwidgets.com/api/campaigns
Paramètres Détails Description
domain_id Facultatif Entier -
name Obligatoire Chaîne de caractères -
domain Obligatoire Chaîne de caractères -
branding_name Facultatif Chaîne de caractères -
branding_url Facultatif Chaîne de caractères -
email_reports Facultatif Tableau ID des canaux de notification
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://wwidgets.com/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-16 16:46:51"
    }
}

Modifier

POST https://wwidgets.com/api/campaigns/{campaign_id}
Paramètres Détails Description
domain_id Facultatif Entier -
name Facultatif Chaîne de caractères -
domain Facultatif Chaîne de caractères -
branding_name Facultatif Chaîne de caractères -
branding_url Facultatif Chaîne de caractères -
email_reports Facultatif Tableau ID des canaux de notification
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://wwidgets.com/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-16 16:46:51",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:51"
    }
}

Supprimer

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