Zum Inhalt springen

Server-Meldung

POST/v1/conversions

Wann Sie sie nutzen

Nutzen Sie die Server-Meldung für eine Bestellung, die Ihr Server später bestätigt: ein Zahlungs-Webhook, eine telefonische Bestellung, eine CRM-Phase. Ihre Seite speichert das dw_sid aus der Zieladresse, in Ihrer eigenen Sitzung oder im Cookie _dw_sid, das das Pixel setzt, und reicht es beim Anlegen der Bestellung weiter. Sie brauchen einen Tarif mit Conversion-Tracking.

Authentifizieren Sie sich mit dem Meldungs-Geheimnis der Website (Authorization: Bearer dwps_…, nur einmal beim Anlegen oder Rotieren sichtbar) oder mit einem API-Schlüssel mit dem Scope conversions:write.

Anfrage-Body

clickIdstringerforderlichDer Wert dw_sid aus der Zieladresse, genau so, wie er kam.
eventstringerforderlichDer Ereignisname: eines von purchase, lead, signup oder ein Ziel, das Sie angelegt haben. Kleinbuchstaben, Ziffern und Unterstriche.
valuenumberoptionalDer Betrag als Zahl. Eine Erstattung ist ein negativer Betrag.
currencystringoptionalEin ISO-4217-Code wie USD. Pflicht, wenn es einen Wert gibt. Beträge werden nie zwischen Währungen umgerechnet.
orderIdstringoptionalIhre Bestellnummer, bis zu 64 Zeichen. Wird dieselbe noch einmal gesendet, wird sie ignoriert.
occurredAtstringoptionalWann es passiert ist, als ISO-8601-Zeit. Jetzt, wenn sie fehlt. Sie muss im Zuordnungsfenster liegen.
metadataobjectoptionalBis zu 10 kurze Textwerte. Ein Schlüssel oder Wert, der nach personenbezogenen Daten aussieht, wird abgelehnt.

Senden

BeispielPOST /v1/conversions
curl -X POST https://api.dotwick.com/v1/conversions \  -H "Authorization: Bearer dwps_YOUR_POSTBACK_SECRET" \  -H "Content-Type: application/json" \  -d '{    "clickId": "v1.k3m9x2q7c4v1b6n8.a1b2c3d4e5f6.ffk.Hk2LmN0pQ4r",    "event": "purchase",    "value": 49.5,    "currency": "USD",    "orderId": "ORD-1001"  }'

Antwort

Der Aufruf antwortet, bevor die Conversion zugeordnet ist. Der Rest geschieht im Hintergrund: Eine Klick-ID eines anderen Arbeitsbereichs wird abgelehnt, eine außerhalb des Fensters wird als nicht zugeordnet gespeichert, und eine Wiederholung derselben orderId wird ignoriert.

202 Accepted
{  "status": "queued"}

Fehler

400validation_failedEine fehlerhafte Klick-ID, ein Wert ohne Währung, ein unbekanntes Feld oder Metadaten mit personenbezogenen Daten.
401unauthorizedDas Meldungs-Geheimnis oder der API-Schlüssel ist unbekannt.
403feature_not_in_planDer Tarif des Arbeitsbereichs enthält kein Conversion-Tracking.
429rate_limitedZu viele Anfragen; warten Sie die Zeit aus Retry-After ab.

Keine personenbezogenen Daten

  • Der Body ist streng: Ein Feld, das oben nicht steht, etwa eine E-Mail-Adresse oder eine Telefonnummer, lässt die ganze Anfrage scheitern.
  • Metadaten-Schlüssel wie email, phone, name und address werden abgelehnt, ebenso ein Wert, der wie eine E-Mail-Adresse oder Telefonnummer aussieht.