Campagnes

Alles ophalen

GET https://wwidgets.com/api/campaigns/
curl --request GET \
--url 'https://wwidgets.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Beschrijving
search Optioneel String De zoekopdracht.
search_by Optioneel String In welk veld je zoekt. Toegestane waarden zijn: name, domain.
is_enabled Optioneel Boolean
datetime_field Optioneel String Toegestane waarden: datetime, last_datetime
datetime_start Optioneel String Filter resultaten vanaf deze datum en tijd. Formaat Y-m-d H:i:s.
datetime_end Optioneel String Filter resultaten tot deze datum en tijd. Formaat Y-m-d H:i:s.
order_by Optioneel String Op welk veld de resultaten worden gesorteerd. Toegestane waarden zijn: campaign_id, datetime, last_datetime, name, domain.
order_type Optioneel String De sortering van de resultaten. Toegestane waarden zijn: ASC voor oplopende sortering en DESC voor aflopende sortering.
page Optioneel Integer Het paginanummer waarvan je resultaten wilt. Standaard 1.
results_per_page Optioneel Integer Hoeveel resultaten je per pagina wilt. Toegestane waarden zijn: 10, 25, 50, 100, 250, 500, 1000. Standaard 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"
    }
}

Eén ophalen

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"
    }
}

Aanmaken

POST https://wwidgets.com/api/campaigns
Parameters Details Beschrijving
domain_id Optioneel Integer -
name Verplicht String -
domain Verplicht String -
branding_name Optioneel String -
branding_url Optioneel String -
email_reports Optioneel Array ID's van meldingskanalen
is_enabled Optioneel 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:51"
    }
}

Bijwerken

POST https://wwidgets.com/api/campaigns/{campaign_id}
Parameters Details Beschrijving
domain_id Optioneel Integer -
name Optioneel String -
domain Optioneel String -
branding_name Optioneel String -
branding_url Optioneel String -
email_reports Optioneel Array ID's van meldingskanalen
is_enabled Optioneel 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:51",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:51"
    }
}

Verwijderen

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