Campagne

Recupera tutto

GET https://widget.spun.zone/api/campaigns/
curl --request GET \
--url 'https://widget.spun.zone/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
search Opzionale Stringa La stringa di ricerca.
search_by Opzionale Stringa In base a quale campo stai cercando. I valori consentiti sono: name, domain.
is_enabled Opzionale Booleano
datetime_field Opzionale Stringa Valori consentiti: datetime, last_datetime
datetime_start Opzionale Stringa Filtra i risultati a partire da questa data e ora. Formato Y-m-d H:i:s.
datetime_end Opzionale Stringa Filtra i risultati fino a questa data e ora. Formato Y-m-d H:i:s.
order_by Opzionale Stringa Per quale campo ordinare i risultati. I valori consentiti sono: campaign_id, datetime, last_datetime, name, domain.
order_type Opzionale Stringa L'ordinamento dei risultati. I valori consentiti sono: ASC per l'ordinamento ascendente e DESC per l'ordinamento discendente.
page Opzionale Intero Il numero della pagina da cui si desiderano i risultati. Predefinito a 1.
results_per_page Opzionale Intero Quanti risultati vuoi per pagina. I valori consentiti sono: 10, 25, 50, 100, 250, 500, 1000. Il valore predefinito è 25. 
{
    "data": [
        {
            "id": 1,
            "pixel_key": "1234567890abcdef",
            "name": "Example",
            "domain": "example.com",
            "branding": {
                "name": "",
                "url": ""
            },
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2019-05-22 23:40:17",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-05-05 23:57:17",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://widget.spun.zone/api/campaigns?page=1",
        "last": "https://widget.spun.zone/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://widget.spun.zone/api/campaigns?page=1"
    }
}

Recupera uno

GET https://widget.spun.zone/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://widget.spun.zone/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "pixel_key": "1234567890abcdef",
        "name": "Example",
        "domain": "example.com",
        "branding": {
            "name": "",
            "url": ""
        },
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2019-05-22 23:40:17",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-05-05 23:57:17",
    }
}

Crea

POST https://widget.spun.zone/api/campaigns
Parametri Dettagli Descrizione
domain_id Opzionale Intero -
name Richiesto Stringa -
domain Richiesto Stringa -
branding_name Opzionale Stringa -
branding_url Opzionale Stringa -
email_reports Opzionale Array ID gestori di notifiche
is_enabled Opzionale Booleano -
curl --request POST \
--url 'https://widget.spun.zone/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

Aggiorna

POST https://widget.spun.zone/api/campaigns/{campaign_id}
Parametri Dettagli Descrizione
domain_id Opzionale Intero -
name Opzionale Stringa -
domain Opzionale Stringa -
branding_name Opzionale Stringa -
branding_url Opzionale Stringa -
email_reports Opzionale Array ID gestori di notifiche
is_enabled Opzionale Booleano -
curl --request POST \
--url 'https://widget.spun.zone/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

Elimina

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