Kampagnen

Hole alles ab

GET https://prooflr.com/api/campaigns/
curl --request GET \
--url 'https://prooflr.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Details Beschreibung
page Optional Integer Die Seitenzahl, von der du die Ergebnisse möchtest. Standardmäßig ist es 1.
results_per_page Optional Integer Wie viele Ergebnisse möchtest du pro Seite sehen? Erlaubte Werte sind: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Standardmäßig 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": "2019-05-22 23:40:17" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://prooflr.com/api/campaigns?&page=1", "last": "https://prooflr.com/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://prooflr.com/api/campaigns?&page=1" } }

Hol ab.

GET https://prooflr.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://prooflr.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": "2019-05-22 23:40:17" } }

Erstellen

POST https://prooflr.com/api/campaigns
Parameter Details Beschreibung
domain_id Optional Integer -
name Benötigt Zeichenkette -
domain Benötigt Zeichenkette -
branding_name Optional Zeichenkette -
branding_url Optional Zeichenkette -
email_reports Optional Array Benachrichtigungs-Handler-IDs
is_enabled Optional Boolean German: Boolean -
curl --request POST \
--url 'https://prooflr.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://prooflr.com/api/campaigns/{campaign_id}
Parameter Details Beschreibung
domain_id Optional Integer -
name Optional Zeichenkette -
domain Optional Zeichenkette -
branding_name Optional Zeichenkette -
branding_url Optional Zeichenkette -
email_reports Optional Array Benachrichtigungs-Handler-IDs
is_enabled Optional Boolean German: Boolean -
curl --request POST \
--url 'https://prooflr.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://prooflr.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://prooflr.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \