A campaign’s results
Read live from its latest send (D183): sent, delivered, people who opened and clicked and their opens and clicks in all (machines’ opens apart), bounces, complaints, unsubscribes, what wasn’t sent, the orders it earned (D180) and their revenue per currency, opens and clicks per hour and per day, and every link with its clicks. 404 `not_sent` before it has started sending.
Read live from its latest send (D183): sent, delivered, people who opened and clicked and their opens and clicks in all (machines’ opens apart), bounces, complaints, unsubscribes, what wasn’t sent, the orders it earned (D180) and their revenue per currency, opens and clicks per hour and per day, and every link with its clicks. 404 not_sent before it has started sending.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*string^(camp)_[0-9A-Za-z]{8}$OK
application/json- response
send*|nullsent*integerdelivered*integeropened*integeropens*integermachineOpenedOnly*integerclicked*integerclicks*integerbounced*integerhardBounced*integercomplained*integerunsubscribed*integernotSent*integerorders*integerbuyers*integerrevenue*array<>activity*links*array<>curl -X GET 'https://api.postforge.dev/v1/campaigns/string/results'{ "send": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "scheduled", "scheduledAt": "2019-08-24T14:15:22Z", "timeZone": "string", "campaignVersionId": "39ec451d-3233-4d62-ae15-7fb6a61cb71a", "emailVersionId": "5aa7582b-c80e-4f53-9246-74f188431e79", "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "failureReason": "email_has_issues", "failureDetail": "string", "noEmail": 0, "notSubscribed": 0 }, "sent": 0, "delivered": 0, "opened": 0, "opens": 0, "machineOpenedOnly": 0, "clicked": 0, "clicks": 0, "bounced": 0, "hardBounced": 0, "complained": 0, "unsubscribed": 0, "notSent": 0, "orders": 0, "buyers": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ], "activity": { "hourly": [ { "at": "2019-08-24T14:15:22Z", "opens": 0, "clicks": 0 } ], "daily": [ { "at": "2019-08-24T14:15:22Z", "opens": 0, "clicks": 0 } ] }, "links": [ { "url": "string", "label": "string", "people": 0, "clicks": 0 } ]}Cancel a campaign’s send POST
Stops a scheduled or sending campaign: what hasn’t gone out yet is cancelled (emails already handed to the provider still arrive). It can’t be scheduled again; duplicate it to send it later. 409 `not_sending` when there’s nothing to cancel.
What a campaign’s orders came to GET
The orders attributed to its latest send (D180): revenue, orders and average per currency, buyers, new customers, items sold and the bestselling products, with the attribution windows they were decided with.