Segmente

Alle abrufen

GET https://sitepush.de/api/segments/
curl --request GET \
--url 'https://sitepush.de/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Einzelheiten Beschreibung
search Optional Zeichenkette Die Suchzeichenfolge.
search_by Optional Zeichenkette Nach welchem Feld suchen Sie? Erlaubte Werte sind: name.
website_id Optional Ganzzahl
order_by Optional Zeichenkette Nach welchem Feld die Ergebnisse sortiert werden sollen. Erlaubte Werte sind: segment_id , datetime , last_datetime , name , total_subscribers.
order_type Optional Zeichenkette Die Anordnung der Ergebnisse. Erlaubte Werte sind: ASC für aufsteigende Anordnung und DESC für absteigende Anordnung.
page Optional Ganzzahl Die Seitennummer, von der Sie Ergebnisse wünschen. Standardmäßig 1.
results_per_page Optional Ganzzahl Wie viele Ergebnisse möchten Sie pro Seite? Erlaubte Werte sind: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Standardmäßig 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-03-01 13:43:30",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sitepush.de/api/segments?page=1",
        "last": "https://sitepush.de/api/segments?page=1",
        "next": null,
        "prev": null,
        "self": "https://sitepush.de/api/segments?page=1"
    }
}

Eins abrufen

GET https://sitepush.de/api/segments/{segment_id}
curl --request GET \
--url 'https://sitepush.de/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-03-01 13:43:30",
    }
}

Erstellen

POST https://sitepush.de/api/segments
Parameter Einzelheiten Beschreibung
website_id Erforderlich Ganzzahl -
name Erforderlich Zeichenkette -
type Optional Zeichenkette Erlaubte Werte: custom , filter
subscribers_ids Optional Zeichenkette Verfügbar, wenn: segment = custom
filters_custom_parameter_key[index] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_custom_parameter_condition[index] Optional Zeichenkette Erlaubte Werte: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Verfügbar, wenn: segment = filter
filters_custom_parameter_value[index] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_subscribed_on_url Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_cities Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_countries[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_continents[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_device_type[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_languages[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_operating_systems[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_browsers[] Optional Zeichenkette Verfügbar, wenn: segment = filter
curl --request POST \
--url 'https://sitepush.de/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
    }
}

Aktualisieren

POST https://sitepush.de/api/segments/{segment_id}
Parameter Einzelheiten Beschreibung
website_id Optional Ganzzahl -
name Optional Zeichenkette -
type Optional Zeichenkette Erlaubte Werte: custom , filter
subscribers_ids Optional Zeichenkette Verfügbar, wenn: segment = custom
filters_custom_parameter_key[index] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_custom_parameter_condition[index] Optional Zeichenkette Erlaubte Werte: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Verfügbar, wenn: segment = filter
filters_custom_parameter_value[index] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_subscribed_on_url Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_cities Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_countries[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_continents[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_device_type[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_languages[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_operating_systems[] Optional Zeichenkette Verfügbar, wenn: segment = filter
filters_browsers[] Optional Zeichenkette Verfügbar, wenn: segment = filter
curl --request POST \
--url 'https://sitepush.de/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
    }
}

Löschen

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