Kampagnen

Alle abrufen

GET https://theeasypopup.com/api/campaigns/
curl --request GET \
--url 'https://theeasypopup.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Details Beschreibung
search Optional Zeichenkette Die Suchzeichenfolge.
search_by Optional Zeichenkette Nach welchem Feld suchen Sie. Zulässige Werte sind: name, domain.
is_enabled Optional Boolesch
datetime_field Optional Zeichenkette Erlaubte Werte: datetime, last_datetime
datetime_start Optional Zeichenkette Ergebnisse ab diesem Datum und dieser Uhrzeit filtern. Format Y-m-d H:i:s.
datetime_end Optional Zeichenkette Ergebnisse bis zu diesem Datum und dieser Uhrzeit filtern. Format Y-m-d H:i:s.
order_by Optional Zeichenkette Nach welchem Feld die Ergebnisse sortiert werden sollen. Erlaubte Werte sind: campaign_id, datetime, last_datetime, name, domain.
order_type Optional Zeichenkette Die Sortierung der Ergebnisse. Zulässige Werte sind: ASC für aufsteigende Sortierung, und DESC für absteigende Sortierung.
page Optional Ganzzahl Die Seitennummer, von der Sie Ergebnisse erhalten möchten. Standardwert ist 1.
results_per_page Optional Ganzzahl Wie viele Ergebnisse Sie pro Seite anzeigen möchten. Zulässige Werte sind: 10, 25, 50, 100, 250, 500, 1000. Standardwert ist 25. 
{
    "data": [
        {
            "id": 1,
            "pixel_key": "1234567890abcdef",
            "name": "Example",
            "domain": "example.com",
            "branding": {
                "name": "",
                "url": ""
            },
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2019-05-22 23:40:17",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-08-24 00:19:44",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://theeasypopup.com/api/campaigns?page=1",
        "last": "https://theeasypopup.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://theeasypopup.com/api/campaigns?page=1"
    }
}

Einen abrufen

GET https://theeasypopup.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://theeasypopup.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "pixel_key": "1234567890abcdef",
        "name": "Example",
        "domain": "example.com",
        "branding": {
            "name": "",
            "url": ""
        },
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2019-05-22 23:40:17",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-08-24 00:19:44",
    }
}

Erstellen

POST https://theeasypopup.com/api/campaigns
Parameter Details Beschreibung
domain_id Optional Ganzzahl -
name Erforderlich Zeichenkette -
domain Erforderlich Zeichenkette -
branding_name Optional Zeichenkette -
branding_url Optional Zeichenkette -
email_reports Optional Array Benachrichtigungs-Handler-IDs
is_enabled Optional Boolesch -
curl --request POST \
--url 'https://theeasypopup.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

Aktualisieren

POST https://theeasypopup.com/api/campaigns/{campaign_id}
Parameter Details Beschreibung
domain_id Optional Ganzzahl -
name Optional Zeichenkette -
domain Optional Zeichenkette -
branding_name Optional Zeichenkette -
branding_url Optional Zeichenkette -
email_reports Optional Array Benachrichtigungs-Handler-IDs
is_enabled Optional Boolesch -
curl --request POST \
--url 'https://theeasypopup.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

Löschen

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