Segmentos

Recuperar tudo

GET https://esolucaomkt.online/api/segments/
curl --request GET \
--url 'https://esolucaomkt.online/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional Corda A sequência de pesquisa.
search_by Opcional Corda Por qual campo você está pesquisando. Os valores permitidos são: name.
website_id Opcional Inteiro
datetime_field Opcional Corda Valores permitidos: datetime, last_datetime
datetime_start Opcional Corda Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional Corda Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Corda Por qual campo ordenar os resultados. Os valores permitidos são: segment_id, datetime, last_datetime, name, total_subscribers.
order_type Opcional Corda A ordenação dos resultados. Os valores permitidos são: ASC para ordem crescente e DESC para ordem decrescente.
page Opcional Inteiro O número da página da qual você deseja resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 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-22 23:58:29",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://esolucaomkt.online/api/segments?page=1",
        "last": "https://esolucaomkt.online/api/segments?page=1",
        "next": null,
        "prev": null,
        "self": "https://esolucaomkt.online/api/segments?page=1"
    }
}

Recuperar um

GET https://esolucaomkt.online/api/segments/{segment_id}
curl --request GET \
--url 'https://esolucaomkt.online/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-22 23:58:29",
    }
}

Criar

POST https://esolucaomkt.online/api/segments
Parâmetros Detalhes Descrição
website_id Obrigatório Inteiro -
name Obrigatório Corda -
type Opcional Corda Valores permitidos: custom, filter
subscribers_ids Opcional Corda Disponível quando: segment = custom
filters_custom_parameter_key[index] Opcional Corda Disponível quando: segment = filter
filters_custom_parameter_condition[index] Opcional Corda Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponível quando: segment = filter
filters_custom_parameter_value[index] Opcional Corda Disponível quando: segment = filter
filters_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_seen_online_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_sent_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_subscribed_on_url Opcional Corda Disponível quando: segment = filter
filters_cities Opcional Corda Disponível quando: segment = filter
filters_countries[] Opcional Corda Disponível quando: segment = filter
filters_continents[] Opcional Corda Disponível quando: segment = filter
filters_device_type[] Opcional Corda Disponível quando: segment = filter
filters_languages[] Opcional Corda Disponível quando: segment = filter
filters_operating_systems[] Opcional Corda Disponível quando: segment = filter
filters_browsers[] Opcional Corda Disponível quando: segment = filter
curl --request POST \
--url 'https://esolucaomkt.online/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
    }
}

Atualizar

POST https://esolucaomkt.online/api/segments/{segment_id}
Parâmetros Detalhes Descrição
website_id Opcional Inteiro -
name Opcional Corda -
type Opcional Corda Valores permitidos: custom, filter
subscribers_ids Opcional Corda Disponível quando: segment = custom
filters_custom_parameter_key[index] Opcional Corda Disponível quando: segment = filter
filters_custom_parameter_condition[index] Opcional Corda Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponível quando: segment = filter
filters_custom_parameter_value[index] Opcional Corda Disponível quando: segment = filter
filters_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_seen_online_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_sent_datetime_condition Opcional Corda Disponível quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_subscribed_on_url Opcional Corda Disponível quando: segment = filter
filters_cities Opcional Corda Disponível quando: segment = filter
filters_countries[] Opcional Corda Disponível quando: segment = filter
filters_continents[] Opcional Corda Disponível quando: segment = filter
filters_device_type[] Opcional Corda Disponível quando: segment = filter
filters_languages[] Opcional Corda Disponível quando: segment = filter
filters_operating_systems[] Opcional Corda Disponível quando: segment = filter
filters_browsers[] Opcional Corda Disponível quando: segment = filter
curl --request POST \
--url 'https://esolucaomkt.online/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
    }
}

Excluir

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