Campañas

Recuperar todo

GET https://pushye.com/api/campaigns/
curl --request GET \
--url 'https://pushye.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
search Opcional Cadena La cadena de búsqueda.
search_by Opcional Cadena ¿Qué campo estás buscando? Los valores permitidos son: name, title, description, url.
status Opcional Cadena Valores permitidos: draft, scheduled, processing, sent
website_id Opcional Entero
datetime_field Opcional Cadena Valores permitidos: datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Opcional Cadena Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional Cadena Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional Cadena Qué campo ordenar los resultados por. Los valores permitidos son: campaign_id, datetime, last_datetime, scheduled_datetime, last_sent_datetime, name, title, total_push_notifications, total_sent_push_notifications, total_displayed_push_notifications, total_clicked_push_notifications, total_closed_push_notifications.
order_type Opcional Cadena 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 deseas obtener resultados. Por defecto es 1.
results_per_page Opcional Entero Cuántos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. Por defecto es 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "name": "Example",
            "title": "Sample message",
            "description": "This is coming from the API.",
            "url": "https://example.com",
            "image_url": null,
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
                "ttl": 2419200,
                "urgency": "normal",
                "is_silent": 0,
                "is_auto_hide": 0,
                "button_title_1": "",
                "button_url_1": "",
                "button_title_2": "",
                "button_url_2": ""
            },
            "subscribers_ids": [
                1,2,3,4,5
            ],
            "sent_subscribers_ids": [],
            "total_sent_push_notifications": 0,
            "total_push_notifications": 1,
            "total_displayed_push_notifications": 0,
            "total_clicked_push_notifications": 0,
            "total_closed_push_notifications": 0,
            "status": "draft",
            "scheduled_datetime": "2024-08-09 00:16:22",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-04-28 18:37:28",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushye.com/api/campaigns?page=1",
        "last": "https://pushye.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/campaigns?page=1"
    }
}

Recuperar uno

GET https://pushye.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pushye.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Sample message",
        "description": "This is coming from the API.",
        "url": "https://example.com",
        "image_url": null,
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
            "ttl": 2419200,
            "urgency": "normal",
            "is_silent": 0,
            "is_auto_hide": 0,
            "button_title_1": "",
            "button_url_1": "",
            "button_title_2": "",
            "button_url_2": ""
        },
        "subscribers_ids": [
            1,2,3,4,5
        ],
        "sent_subscribers_ids": [],
        "total_sent_push_notifications": 0,
        "total_push_notifications": 1,
        "total_displayed_push_notifications": 0,
        "total_clicked_push_notifications": 0,
        "total_closed_push_notifications": 0,
        "status": "draft",
        "scheduled_datetime": "2024-08-09 00:16:22",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-04-28 18:37:28",
    }
}

Crear

POST https://pushye.com/api/campaigns
Parámetros Detalles Descripción
website_id Requerido Entero -
name Requerido Cadena -
title Requerido Cadena -
description Requerido Cadena -
url Opcional Cadena -
image Opcional Archivo -
button_title_1 Opcional Cadena -
button_url_1 Opcional Cadena -
button_title_2 Opcional Cadena -
button_url_2 Opcional Cadena -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional Cadena -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional Cadena Valores permitidos: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opcional Cadena Valores permitidos: all, custom, filter, INT segment_id
subscribers_ids Opcional Cadena Disponible cuando: segment = custom
filters_custom_parameter_key[index] Opcional Cadena Disponible cuando: segment = filter
filters_custom_parameter_condition[index] Opcional Cadena Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible cuando: segment = filter
filters_custom_parameter_value[index] Opcional Cadena Disponible cuando: segment = filter
filters_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_seen_online_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_sent_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_subscribed_on_url Opcional Cadena Disponible cuando: segment = filter
filters_cities Opcional Cadena Disponible cuando: segment = filter
filters_countries[] Opcional Cadena Disponible cuando: segment = filter
filters_continents[] Opcional Cadena Disponible cuando: segment = filter
filters_device_type[] Opcional Cadena Disponible cuando: segment = filter
filters_languages[] Opcional Cadena Disponible cuando: segment = filter
filters_operating_systems[] Opcional Cadena Disponible cuando: segment = filter
filters_browsers[] Opcional Cadena Disponible cuando: segment = filter
utm_source Opcional Cadena -
utm_medium Opcional Cadena -
utm_campaign Opcional Cadena -
save Opcional Boolean Guardar borrador
send Opcional Boolean Enviar campaña
curl --request POST \
--url 'https://pushye.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Actualizar

POST https://pushye.com/api/campaigns/{campaign_id}
Parámetros Detalles Descripción
website_id Opcional Entero -
name Opcional Cadena -
title Opcional Cadena -
description Opcional Cadena -
url Opcional Cadena -
image Opcional Archivo -
button_title_1 Opcional Cadena -
button_url_1 Opcional Cadena -
button_title_2 Opcional Cadena -
button_url_2 Opcional Cadena -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional Cadena -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional Cadena Valores permitidos: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opcional Cadena Valores permitidos: all, custom, filter, INT segment_id
subscribers_ids Opcional Cadena Disponible cuando: segment = custom
filters_custom_parameter_key[index] Opcional Cadena Disponible cuando: segment = filter
filters_custom_parameter_condition[index] Opcional Cadena Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible cuando: segment = filter
filters_custom_parameter_value[index] Opcional Cadena Disponible cuando: segment = filter
filters_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_seen_online_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_last_sent_datetime_condition Opcional Cadena Disponible cuando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Entero Disponible cuando: segment = filter días
filters_subscribed_on_url Opcional Cadena Disponible cuando: segment = filter
filters_cities Opcional Cadena Disponible cuando: segment = filter
filters_countries[] Opcional Cadena Disponible cuando: segment = filter
filters_continents[] Opcional Cadena Disponible cuando: segment = filter
filters_device_type[] Opcional Cadena Disponible cuando: segment = filter
filters_languages[] Opcional Cadena Disponible cuando: segment = filter
filters_operating_systems[] Opcional Cadena Disponible cuando: segment = filter
filters_browsers[] Opcional Cadena Disponible cuando: segment = filter
utm_source Opcional Cadena -
utm_medium Opcional Cadena -
utm_campaign Opcional Cadena -
save Opcional Boolean Guardar borrador
send Opcional Boolean Enviar campaña
curl --request POST \
--url 'https://pushye.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Eliminar

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