Campagne

Recupera tutto

GET https://push.gtechgroup.it/api/campaigns/
curl --request GET \
--url 'https://push.gtechgroup.it/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
search Opzionale Corda La stringa di ricerca.
search_by Opzionale Corda In quale campo stai cercando. I valori consentiti sono: name, title, description, url.
status Opzionale Corda Valori consentiti: draft, scheduled, processing, sent
website_id Opzionale Intero
datetime_field Opzionale Corda Valori consentiti: datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Opzionale Corda Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opzionale Corda Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opzionale Corda Quale campo utilizzare per ordinare i risultati. I valori consentiti sono: campaign_id, datetime, last_datetime, scheduled_datetime, last_sent_datetime, name, title, total_push_notifications, total_sent_push_notifications, total_displayed_push_notifications, total_clicked_push_notifications, total_closed_push_notifications.
order_type Opzionale Corda L'ordinamento dei risultati. I valori consentiti sono: ASC per l'ordinamento ascendente, e DESC per l'ordinamento discendente.
page Opzionale Intero Il numero di pagina da cui desideri i risultati. Predefinito a 1.
results_per_page Opzionale Intero Quanti risultati vuoi per pagina. I valori consentiti sono: 10, 25, 50, 100, 250, 500, 1000. Predefinito a 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "name": "Example",
            "title": "Sample message",
            "description": "This is coming from the API.",
            "url": "https://example.com",
            "image_url": null,
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
                "ttl": 2419200,
                "urgency": "normal",
                "is_silent": 0,
                "is_auto_hide": 0,
                "button_title_1": "",
                "button_url_1": "",
                "button_title_2": "",
                "button_url_2": ""
            },
            "subscribers_ids": [
                1,2,3,4,5
            ],
            "sent_subscribers_ids": [],
            "total_sent_push_notifications": 0,
            "total_push_notifications": 1,
            "total_displayed_push_notifications": 0,
            "total_clicked_push_notifications": 0,
            "total_closed_push_notifications": 0,
            "status": "draft",
            "scheduled_datetime": "2024-08-09 00:16:22",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-07-15 18:53:05",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://push.gtechgroup.it/api/campaigns?page=1",
        "last": "https://push.gtechgroup.it/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://push.gtechgroup.it/api/campaigns?page=1"
    }
}

Recupera uno

GET https://push.gtechgroup.it/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://push.gtechgroup.it/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "name": "Example",
        "title": "Sample message",
        "description": "This is coming from the API.",
        "url": "https://example.com",
        "image_url": null,
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
            "ttl": 2419200,
            "urgency": "normal",
            "is_silent": 0,
            "is_auto_hide": 0,
            "button_title_1": "",
            "button_url_1": "",
            "button_title_2": "",
            "button_url_2": ""
        },
        "subscribers_ids": [
            1,2,3,4,5
        ],
        "sent_subscribers_ids": [],
        "total_sent_push_notifications": 0,
        "total_push_notifications": 1,
        "total_displayed_push_notifications": 0,
        "total_clicked_push_notifications": 0,
        "total_closed_push_notifications": 0,
        "status": "draft",
        "scheduled_datetime": "2024-08-09 00:16:22",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-07-15 18:53:05",
    }
}

Crea

POST https://push.gtechgroup.it/api/campaigns
Parametri Dettagli Descrizione
website_id Richiesto Intero -
name Richiesto Corda -
title Richiesto Corda -
description Richiesto Corda -
url Opzionale Corda -
image Opzionale File -
button_title_1 Opzionale Corda -
button_url_1 Opzionale Corda -
button_title_2 Opzionale Corda -
button_url_2 Opzionale Corda -
is_scheduled Opzionale Booleano -
scheduled_datetime Opzionale Corda -
is_silent Opzionale Booleano -
is_auto_hide Opzionale Booleano -
ttl Opzionale Corda Valori consentiti: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opzionale Corda Valori consentiti: all, custom, filter, INT segment_id
subscribers_ids Opzionale Corda Disponibile quando: segment = custom
filters_custom_parameter_key[index] Opzionale Corda Disponibile quando: segment = filter
filters_custom_parameter_condition[index] Opzionale Corda 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] Opzionale Corda Disponibile quando: segment = filter
filters_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_seen_online_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_sent_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_subscribed_on_url Opzionale Corda Disponibile quando: segment = filter
filters_cities Opzionale Corda Disponibile quando: segment = filter
filters_countries[] Opzionale Corda Disponibile quando: segment = filter
filters_continents[] Opzionale Corda Disponibile quando: segment = filter
filters_device_type[] Opzionale Corda Disponibile quando: segment = filter
filters_languages[] Opzionale Corda Disponibile quando: segment = filter
filters_operating_systems[] Opzionale Corda Disponibile quando: segment = filter
filters_browsers[] Opzionale Corda Disponibile quando: segment = filter
utm_source Opzionale Corda -
utm_medium Opzionale Corda -
utm_campaign Opzionale Corda -
save Opzionale Booleano Salva bozza
send Opzionale Booleano Invia campagna
curl --request POST \
--url 'https://push.gtechgroup.it/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Aggiorna

POST https://push.gtechgroup.it/api/campaigns/{campaign_id}
Parametri Dettagli Descrizione
website_id Opzionale Intero -
name Opzionale Corda -
title Opzionale Corda -
description Opzionale Corda -
url Opzionale Corda -
image Opzionale File -
button_title_1 Opzionale Corda -
button_url_1 Opzionale Corda -
button_title_2 Opzionale Corda -
button_url_2 Opzionale Corda -
is_scheduled Opzionale Booleano -
scheduled_datetime Opzionale Corda -
is_silent Opzionale Booleano -
is_auto_hide Opzionale Booleano -
ttl Opzionale Corda Valori consentiti: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opzionale Corda Valori consentiti: all, custom, filter, INT segment_id
subscribers_ids Opzionale Corda Disponibile quando: segment = custom
filters_custom_parameter_key[index] Opzionale Corda Disponibile quando: segment = filter
filters_custom_parameter_condition[index] Opzionale Corda 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] Opzionale Corda Disponibile quando: segment = filter
filters_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_seen_online_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_last_sent_datetime_condition Opzionale Corda Disponibile quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opzionale Intero Disponibile quando: segment = filter giorni
filters_subscribed_on_url Opzionale Corda Disponibile quando: segment = filter
filters_cities Opzionale Corda Disponibile quando: segment = filter
filters_countries[] Opzionale Corda Disponibile quando: segment = filter
filters_continents[] Opzionale Corda Disponibile quando: segment = filter
filters_device_type[] Opzionale Corda Disponibile quando: segment = filter
filters_languages[] Opzionale Corda Disponibile quando: segment = filter
filters_operating_systems[] Opzionale Corda Disponibile quando: segment = filter
filters_browsers[] Opzionale Corda Disponibile quando: segment = filter
utm_source Opzionale Corda -
utm_medium Opzionale Corda -
utm_campaign Opzionale Corda -
save Opzionale Booleano Salva bozza
send Opzionale Booleano Invia campagna
curl --request POST \
--url 'https://push.gtechgroup.it/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Elimina

DELETE https://push.gtechgroup.it/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://push.gtechgroup.it/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \