An automation’s results
For a period (`7d`, `30d`, `90d` or `all`), read live (D202): how often its trigger fired and what came of it, who is in it now and how runs ended, and per step how many reached it, are there now, the paths they took and what its email did and earned (orders attributed to its messages, D180).
For a period (7d, 30d, 90d or all), read live (D202): how often its trigger fired and what came of it, who is in it now and how runs ended, and per step how many reached it, are there now, the paths they took and what its email did and earned (orders attributed to its messages, D180).
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*string^(auto)_[0-9A-Za-z]{8}$period?string"30d""7d""30d""90d""all"OK
application/json- response
period*string"7d""30d""90d""all"from*|date-timefired*integerentries*active*integercompleted*integerexited*integerfailed*integeremailsSent*integerorders*integerrevenue*array<>steps*array<>curl -X GET 'https://api.postforge.dev/v1/automations/string/results'{ "period": "7d", "from": "2019-08-24T14:15:22Z", "fired": 0, "entries": { "entered": 0, "conditions_not_met": 0, "not_eligible": 0, "entered_before": 0, "still_in": 0, "no_person": 0 }, "active": 0, "completed": 0, "exited": 0, "failed": 0, "emailsSent": 0, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ], "steps": [ { "stepId": "string", "reached": 0, "here": 0, "outcomes": { "waited": 0, "took_path": 0, "sent": 0, "skipped": 0, "done": 0, "refused": 0, "failed": 0, "exited": 0 }, "paths": [ { "pathId": "string", "people": 0 } ], "email": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ] } } ]}Put an automation back to a draft POST
Back to a draft: nobody enters any more, and everyone in it leaves (`back_to_draft`): nothing more is sent to them from it.
An email step’s results GET
As a campaign’s results, over every message the step sent in the period: delivery, opens and clicks (people’s, D153), unsubscribes, orders and revenue, activity per day and every link. 404 for a step that never sent.