Segmenten

HĂ€mta alla

GET https://pushye.com/api/segments/
curl --request GET \
--url 'https://pushye.com/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
Parametrar Detaljer Beskrivning
search Valfritt StrÀng SökstrÀngen.
search_by Valfritt StrÀng Vilket fÀlt söker du efter? TillÄtna vÀrden Àr: name.
website_id Valfritt Heltal
datetime_field Valfritt StrÀng TillÄtna vÀrden: datetime, last_datetime
datetime_start Valfritt StrÀng Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Valfritt StrÀng Filter results up to this datetime. Y-m-d H:i:s format.
order_by Valfritt StrÀng Vilket fÀlt att sortera resultaten efter. TillÄtna vÀrden Àr: segment_id, datetime, last_datetime, name, total_subscribers.
order_type Valfritt StrÀng Ordningen av resultaten. TillÄtna vÀrden Àr: ASC för stigande ordning, och DESC för fallande ordning.
page Valfritt Heltal Sidanummeret som du vill ha resultat frÄn. StandardinstÀllning Àr 1.
results_per_page Valfritt Heltal Hur mÄnga resultat vill du ha per sida. TillÄtna vÀrden Àr: 10, 25, 50, 100, 250, 500, 1000. StandardvÀrde Àr 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-06-12 22:43:38",
        }
    ],
    "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"
    }
}

HĂ€mta en

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-06-12 22:43:38",
    }
}

Skapa

POST https://pushye.com/api/segments
Parametrar Detaljer Beskrivning
website_id Obligatoriskt Heltal -
name Obligatoriskt StrÀng -
type Valfritt StrÀng TillÄtna vÀrden: custom, filter
subscribers_ids Valfritt StrÀng TillgÀnglig nÀr: segment = custom
filters_custom_parameter_key[index] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_custom_parameter_condition[index] Valfritt StrÀng TillÄtna vÀrden: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than TillgÀnglig nÀr: segment = filter
filters_custom_parameter_value[index] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_seen_online_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_sent_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_sent_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_subscribed_on_url Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_cities Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_countries[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_continents[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_device_type[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_languages[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_operating_systems[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_browsers[] Valfritt StrÀng TillgÀnglig nÀr: 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
    }
}

Uppdatera

POST https://pushye.com/api/segments/{segment_id}
Parametrar Detaljer Beskrivning
website_id Valfritt Heltal -
name Valfritt StrÀng -
type Valfritt StrÀng TillÄtna vÀrden: custom, filter
subscribers_ids Valfritt StrÀng TillgÀnglig nÀr: segment = custom
filters_custom_parameter_key[index] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_custom_parameter_condition[index] Valfritt StrÀng TillÄtna vÀrden: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than TillgÀnglig nÀr: segment = filter
filters_custom_parameter_value[index] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_seen_online_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_last_sent_datetime_condition Valfritt StrÀng TillgÀnglig nÀr: segment = filter within_last, older_than
filters_last_sent_datetime_value Valfritt Heltal TillgÀnglig nÀr: segment = filter dagar
filters_subscribed_on_url Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_cities Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_countries[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_continents[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_device_type[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_languages[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_operating_systems[] Valfritt StrÀng TillgÀnglig nÀr: segment = filter
filters_browsers[] Valfritt StrÀng TillgÀnglig nÀr: 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
    }
}

Ta bort

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