Segmentos

Recuperar todo

GET https://pushye.com/api/segments/
curl --request GET \
--url 'https://pushye.com/api/segments/' \
--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.
website_id Opcional Entero
datetime_field Opcional Cadena Valores permitidos: 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: segment_id, datetime, last_datetime, name, total_subscribers.
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",
            "settings": {
                "subscribers_ids": [1,2,3,4,5]
            },
            "type": "custom",
            "total_subscribers": 5,
            "last_datetime": null,
            "datetime": "2026-04-28 18:36:41",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushye.com/api/segments?page=1",
        "last": "https://pushye.com/api/segments?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/segments?page=1"
    }
}

Recuperar uno

GET https://pushye.com/api/segments/{segment_id}
curl --request GET \
--url 'https://pushye.com/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "settings": {
            "subscribers_ids": [1,2,3,4,5]
        },
        "type": "filter",
        "total_subscribers": 5,
        "last_datetime": null,
        "datetime": "2026-04-28 18:36:41",
    }
}

Crear

POST https://pushye.com/api/segments
Parámetros Detalles Descripción
website_id Requerido Entero -
name Requerido Cadena -
type Opcional Cadena Valores permitidos: custom, filter
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
curl --request POST \
--url 'https://pushye.com/api/segments' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'type=custom' \
--form 'subscribers_ids=1,2,3,4,5' \
{
    "data": {
        "id": 1
    }
}

Actualizar

POST https://pushye.com/api/segments/{segment_id}
Parámetros Detalles Descripción
website_id Opcional Entero -
name Opcional Cadena -
type Opcional Cadena Valores permitidos: custom, filter
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
curl --request POST \
--url 'https://pushye.com/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'type=custom' \
--form 'subscribers_ids=1,2,3,4,5' \
{
    "data": {
        "id": 1
    }
}

Eliminar

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