段落

检索所有

GET https://pushye.com/api/segments/
curl --request GET \
--url 'https://pushye.com/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
参数 细节 描述
search 可选的 字符串 搜索字符串。
search_by 可选的 字符串 您正在按哪个字段搜索。允许的值为：name。
website_id 可选的 整数
datetime_field 可选的 字符串 允许的值：datetime, last_datetime
datetime_start 可选的 字符串 Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end 可选的 字符串 Filter results up to this datetime. Y-m-d H:i:s format.
order_by 可选的 字符串 按哪个字段排序结果。允许的值有：segment_id, datetime, last_datetime, name, total_subscribers。
order_type 可选的 字符串 结果的排序。允许的值为：ASC 表示升序排序，DESC 表示降序排序。
page 可选的 整数 您想要结果的页码。默认为 1。
results_per_page 可选的 整数 每页您想要多少个结果。允许的值是：10, 25, 50, 100, 250, 500, 1000。默认为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-13 00:07:31",
        }
    ],
    "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"
    }
}

检索一个

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-13 00:07:31",
    }
}

创建

POST https://pushye.com/api/segments
参数 细节 描述
website_id 必需 整数 -
name 必需 字符串 -
type 可选的 字符串 允许的值：custom, filter
subscribers_ids 可选的 字符串 可用时间：segment = custom
filters_custom_parameter_key[index] 可选的 字符串 可用时间：segment = filter
filters_custom_parameter_condition[index] 可选的 字符串 允许的值：exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than 可用时间：segment = filter
filters_custom_parameter_value[index] 可选的 字符串 可用时间：segment = filter
filters_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_seen_online_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_seen_online_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_sent_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_sent_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_subscribed_on_url 可选的 字符串 可用时间：segment = filter
filters_cities 可选的 字符串 可用时间：segment = filter
filters_countries[] 可选的 字符串 可用时间：segment = filter
filters_continents[] 可选的 字符串 可用时间：segment = filter
filters_device_type[] 可选的 字符串 可用时间：segment = filter
filters_languages[] 可选的 字符串 可用时间：segment = filter
filters_operating_systems[] 可选的 字符串 可用时间：segment = filter
filters_browsers[] 可选的 字符串 可用时间：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
    }
}

更新

POST https://pushye.com/api/segments/{segment_id}
参数 细节 描述
website_id 可选的 整数 -
name 可选的 字符串 -
type 可选的 字符串 允许的值：custom, filter
subscribers_ids 可选的 字符串 可用时间：segment = custom
filters_custom_parameter_key[index] 可选的 字符串 可用时间：segment = filter
filters_custom_parameter_condition[index] 可选的 字符串 允许的值：exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than 可用时间：segment = filter
filters_custom_parameter_value[index] 可选的 字符串 可用时间：segment = filter
filters_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_seen_online_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_seen_online_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_last_sent_datetime_condition 可选的 字符串 可用时间：segment = filter within_last, older_than
filters_last_sent_datetime_value 可选的 整数 可用时间：segment = filter 天数
filters_subscribed_on_url 可选的 字符串 可用时间：segment = filter
filters_cities 可选的 字符串 可用时间：segment = filter
filters_countries[] 可选的 字符串 可用时间：segment = filter
filters_continents[] 可选的 字符串 可用时间：segment = filter
filters_device_type[] 可选的 字符串 可用时间：segment = filter
filters_languages[] 可选的 字符串 可用时间：segment = filter
filters_operating_systems[] 可选的 字符串 可用时间：segment = filter
filters_browsers[] 可选的 字符串 可用时间：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
    }
}

删除

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