Naar de inhoud

Server-postback

POST/v1/conversions

Wanneer gebruik je het

Gebruik een postback voor een bestelling die je server later bevestigt: een betaalwebhook, een telefonische bestelling, een CRM-fase. Je pagina bewaart de dw_sid uit het landingsadres, in je eigen sessie of in het cookie _dw_sid dat de pixel plaatst, en geeft hem door bij het aanmaken van de bestelling. Het vereist een abonnement met conversietracking.

Authenticeer met het postback-geheim van de site (Authorization: Bearer dwps_…, één keer getoond bij het aanmaken of roteren) of met een API-sleutel met de scope conversions:write.

Request-body

clickIdstringverplichtDe dw_sid-waarde uit het landingsadres, precies zoals hij kwam.
eventstringverplichtDe naam van de gebeurtenis: een van purchase, lead, signup, of een doel dat je maakte. Kleine letters, cijfers en underscores.
valuenumberoptioneelHet bedrag, als getal. Een terugbetaling is een negatief bedrag.
currencystringoptioneelEen ISO 4217-code zoals USD. Vereist als er een waarde is. Bedragen worden nooit tussen valuta’s omgerekend.
orderIdstringoptioneelJe bestelnummer, tot 64 tekens. Hetzelfde nummer opnieuw sturen wordt genegeerd.
occurredAtstringoptioneelWanneer het gebeurde, als ISO 8601-tijd. Nu als hij ontbreekt. Het moet binnen het attributievenster vallen.
metadataobjectoptioneelTot 10 korte tekstwaarden. Een sleutel of waarde die op persoonsgegevens lijkt, wordt geweigerd.

Verstuur hem

voorbeeldPOST /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"  }'

Antwoord

De aanroep antwoordt voordat de conversie is toegeschreven. De rest gebeurt op de achtergrond: een klik-id van een andere werkruimte wordt geweigerd, een klik-id buiten het venster wordt als niet-toegeschreven bewaard en een herhaling van dezelfde orderId wordt genegeerd.

202 Accepted
{  "status": "queued"}

Fouten

400validation_failedEen misvormd klik-id, een waarde zonder valuta, een onbekend veld of metadata met persoonsgegevens.
401unauthorizedHet postback-geheim of de API-sleutel is onbekend.
403feature_not_in_planHet abonnement van de werkruimte bevat geen conversietracking.
429rate_limitedTe veel verzoeken; wacht op Retry-After.

Geen persoonsgegevens

  • De body is strikt: een veld dat hierboven niet staat, waaronder een e-mailadres of telefoonnummer, laat het hele verzoek mislukken.
  • Metadatasleutels zoals email, phone, name en address worden geweigerd, evenals een waarde die op een e-mailadres of telefoonnummer lijkt.