Kampagnen

Alle abrufen

GET https://wwidgets.com/api/campaigns/
curl --request GET \
--url 'https://wwidgets.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Details Beschreibung
search Optional String Der Suchbegriff.
search_by Optional String In welchem Feld gesucht werden soll. Erlaubte Werte: name, domain.
is_enabled Optional Boolean
datetime_field Optional String Erlaubte Werte: datetime, last_datetime
datetime_start Optional String Ergebnisse ab diesem Zeitpunkt filtern. Format Y-m-d H:i:s.
datetime_end Optional String Ergebnisse bis zu diesem Zeitpunkt filtern. Format Y-m-d H:i:s.
order_by Optional String Nach welchem Feld die Ergebnisse sortiert werden sollen. Erlaubte Werte: campaign_id, datetime, last_datetime, name, domain.
order_type Optional String Die Sortierreihenfolge der Ergebnisse. Erlaubte Werte: ASC für aufsteigende und DESC für absteigende Sortierung.
page Optional Integer Die Seitennummer, von der Sie Ergebnisse möchten. Standardwert ist 1.
results_per_page Optional Integer Wie viele Ergebnisse Sie pro Seite möchten. Erlaubte Werte: 10, 25, 50, 100, 250, 500, 1000. Standardwert ist 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:31",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-16 16:46:31"
        }
    ],
    "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"
    }
}

Einen abrufen

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:31",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:31"
    }
}

Erstellen

POST https://wwidgets.com/api/campaigns
Parameter Details Beschreibung
domain_id Optional Integer -
name Erforderlich String -
domain Erforderlich String -
branding_name Optional String -
branding_url Optional String -
email_reports Optional Array IDs der Benachrichtigungs-Handler
is_enabled Optional Boolean -
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:31"
    }
}

Aktualisieren

POST https://wwidgets.com/api/campaigns/{campaign_id}
Parameter Details Beschreibung
domain_id Optional Integer -
name Optional String -
domain Optional String -
branding_name Optional String -
branding_url Optional String -
email_reports Optional Array IDs der Benachrichtigungs-Handler
is_enabled Optional Boolean -
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:31",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:31"
    }
}

Löschen

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