Segmenti

Recupera tutto

GET https://pushye.com/api/segments/
curl --request GET \
--url 'https://pushye.com/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
search Facoltativo String La stringa di ricerca.
search_by Facoltativo String Quale campo stai cercando. I valori consentiti sono: name.
website_id Facoltativo Intero
datetime_field Facoltativo String Valori consentiti: datetime, last_datetime
datetime_start Facoltativo String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Facoltativo String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Facoltativo String In quale campo ordinare i risultati. I valori consentiti sono: segment_id, datetime, last_datetime, name, total_subscribers.
order_type Facoltativo String L'ordinamento dei risultati. I valori consentiti sono: ASC per ordinamento crescente e DESC per ordinamento decrescente.
page Facoltativo Intero Il numero di pagina da cui desideri i risultati. Predefinito a 1.
results_per_page Facoltativo Intero Quanti risultati vuoi per pagina. I valori consentiti sono: 10, 25, 50, 100, 250, 500, 1000. Predefinito è 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:38:46",
        }
    ],
    "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"
    }
}

Recupera 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:38:46",
    }
}

Crea

POST https://pushye.com/api/segments
Parametri Dettagli Descrizione
website_id Richiesto Intero -
name Richiesto String -
type Facoltativo String Valori consentiti: custom, filter
subscribers_ids Facoltativo String Disponibile quando: segment = custom
filters_custom_parameter_key[index] Facoltativo String Disponibile quando: segment = filter
filters_custom_parameter_condition[index] Facoltativo String Valori consentiti: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponibile quando: segment = filter
filters_custom_parameter_value[index] Facoltativo String Disponibile quando: segment = filter
filters_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_seen_online_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_sent_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_subscribed_on_url Facoltativo String Disponibile quando: segment = filter
filters_cities Facoltativo String Disponibile quando: segment = filter
filters_countries[] Facoltativo String Disponibile quando: segment = filter
filters_continents[] Facoltativo String Disponibile quando: segment = filter
filters_device_type[] Facoltativo String Disponibile quando: segment = filter
filters_languages[] Facoltativo String Disponibile quando: segment = filter
filters_operating_systems[] Facoltativo String Disponibile quando: segment = filter
filters_browsers[] Facoltativo String Disponibile quando: 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
    }
}

Aggiornare

POST https://pushye.com/api/segments/{segment_id}
Parametri Dettagli Descrizione
website_id Facoltativo Intero -
name Facoltativo String -
type Facoltativo String Valori consentiti: custom, filter
subscribers_ids Facoltativo String Disponibile quando: segment = custom
filters_custom_parameter_key[index] Facoltativo String Disponibile quando: segment = filter
filters_custom_parameter_condition[index] Facoltativo String Valori consentiti: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponibile quando: segment = filter
filters_custom_parameter_value[index] Facoltativo String Disponibile quando: segment = filter
filters_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_seen_online_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_last_sent_datetime_condition Facoltativo String Disponibile quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Facoltativo Intero Disponibile quando: segment = filter giorni
filters_subscribed_on_url Facoltativo String Disponibile quando: segment = filter
filters_cities Facoltativo String Disponibile quando: segment = filter
filters_countries[] Facoltativo String Disponibile quando: segment = filter
filters_continents[] Facoltativo String Disponibile quando: segment = filter
filters_device_type[] Facoltativo String Disponibile quando: segment = filter
filters_languages[] Facoltativo String Disponibile quando: segment = filter
filters_operating_systems[] Facoltativo String Disponibile quando: segment = filter
filters_browsers[] Facoltativo String Disponibile quando: 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
    }
}

Elimina

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