Campañas

Obtener todos

GET https://wwidgets.com/api/campaigns/
curl --request GET \
--url 'https://wwidgets.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
search Opcional Cadena de texto La cadena de búsqueda.
search_by Opcional Cadena de texto Por qué campo estás buscando. Los valores permitidos son: name, domain.
is_enabled Opcional Booleano
datetime_field Opcional Cadena de texto Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadena de texto Filtra los resultados a partir de esta fecha y hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadena de texto Filtra los resultados hasta esta fecha y hora. Formato Y-m-d H:i:s.
order_by Opcional Cadena de texto Por qué campo ordenar los resultados. Los valores permitidos son: campaign_id, datetime, last_datetime, name, domain.
order_type Opcional Cadena de texto El orden de los resultados. Los valores permitidos son: ASC para orden ascendente y DESC para orden descendente.
page Opcional Entero El número de página del que quieres obtener resultados. Por defecto es 1.
results_per_page Opcional Entero Cuántos resultados quieres por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. Por defecto es 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:50",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-16 16:46:50"
        }
    ],
    "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"
    }
}

Obtener uno

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

Crear

POST https://wwidgets.com/api/campaigns
Parámetros Detalles Descripción
domain_id Opcional Entero -
name Obligatorio Cadena de texto -
domain Obligatorio Cadena de texto -
branding_name Opcional Cadena de texto -
branding_url Opcional Cadena de texto -
email_reports Opcional Matriz IDs de los canales de notificación
is_enabled Opcional Booleano -
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:50"
    }
}

Actualizar

POST https://wwidgets.com/api/campaigns/{campaign_id}
Parámetros Detalles Descripción
domain_id Opcional Entero -
name Opcional Cadena de texto -
domain Opcional Cadena de texto -
branding_name Opcional Cadena de texto -
branding_url Opcional Cadena de texto -
email_reports Opcional Matriz IDs de los canales de notificación
is_enabled Opcional Booleano -
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:50",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-16 16:46:50"
    }
}

Eliminar

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