PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List Meta conversions GETExport offline conversions CSV GETRetry a failed Meta conversion POST
Meta

List Meta conversions

GET
/meta/conversions

Authorization

x-api-key<token>

In: header

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0
status?string

Value in

  • "QUEUED"
  • "SENT"
  • "FAILED"
  • "SKIPPED"
  • "EXPORT_ONLY"
siteId?string
source?string

Value in

  • "INVOICE"
  • "MANUAL"
  • "STRIPE"
  • "XENDIT"
  • "RECEIPT"
  • "API"
  • "WORKFLOW"
  • "MCP"
  • "IMPORT"
from?string
Formatdate-time
to?string
Formatdate-time

Response Body

application/json

curl -X GET "https://example.com/meta/conversions"
{  "data": [    {      "id": "string",      "siteId": "string",      "paymentId": "string",      "eventName": "string",      "eventId": "string",      "contactId": "string",      "value": 0,      "currency": "string",      "eventTime": "2019-08-24T14:15:22Z",      "status": "QUEUED",      "skipReason": "string",      "reversed": true,      "attempts": 0,      "lastError": "string",      "sentAt": "2019-08-24T14:15:22Z",      "exportedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Reverse a purchase POST

Marks the payment refunded. Idempotent if already refunded.

Export offline conversions CSV GET

Hashed match keys in Meta's offline upload format. Default rows are SKIPPED (TOO_OLD/NO_SITE/SWITCH_OFF), FAILED, and EXPORT_ONLY. Reversed, OPTED_OUT, and MINOR rows are excluded.