Campaigns sent in a period and what they earned
Each campaign whose send started in the period, with everything that send did and earned (as its results); totals for the period and the one before. Sorts by any count, rate or revenue (in `currency`, else the most used). Rates are left to the reader: opens, clicks, unsubscribes and orders of delivered emails, bounces of sent ones.
Each campaign whose send started in the period, with everything that send did and earned (as its results); totals for the period and the one before. Sorts by any count, rate or revenue (in currency, else the most used). Rates are left to the reader: opens, clicks, unsubscribes and orders of delivered emails, bounces of sent ones.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
from?stringFrom (inclusive)
date-timeto?stringUntil (exclusive)
date-timestoreId?stringOnly orders placed at this store
uuidlocale?stringComma-separated locales (nl-NL), any of them
page?integerStarts at 1
1 <= value1pageSize?numberOne of 10, 25, 50, 100
25q?stringSearch
1 <= length <= 200currency?stringThe currency revenue sorts by; the most used one without it
^[A-Z]{3}$sort?stringOne of sentAt, name, sent, openRate, clickRate, unsubscribeRate, bounceRate, orders, revenue, revenuePerRecipient; prefix with - for descending
"-sentAt""sentAt""-sentAt""name""-name""sent""-sent""openRate""-openRate""clickRate""-clickRate""unsubscribeRate""-unsubscribeRate""bounceRate""-bounceRate""orders""-orders""revenue""-revenue""revenuePerRecipient""-revenuePerRecipient"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integerfrom*|date-timeto*stringdate-timetimeZone*stringtotals*previous*|nullcurrencies*array<string>curl -X GET 'https://api.postforge.dev/v1/analytics/campaigns'{ "items": [ { "sendId": "98079182-77f0-4075-97da-b6e925fc22cb", "campaignId": "string", "name": "string", "sentAt": "2019-08-24T14:15:22Z", "emails": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ] } ], "total": 0, "page": 0, "pageSize": 0, "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "timeZone": "string", "totals": { "emails": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ], "campaigns": 0 }, "previous": { "emails": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ], "campaigns": 0 }, "currencies": [ "string" ]}How email performed in a period GET
The Analytics overview (D212), read live: revenue and orders per currency from campaigns, automations and the store (orders placed in the period), the emails sent per source with what people did with them, both against the as long period before; a series per day, week or month (emails by when they were sent, orders by when they were placed) with the period before bucket by bucket; and the same per locale the emails went in. `storeId` narrows orders to a store, `locale` emails (and their orders) to the locales they went in and the store's orders to their checkout locales. Rates are left to the reader: opens, clicks, unsubscribes and orders of delivered emails, bounces of sent ones.
Automations that emailed in a period and what those emails earned GET
Each automation with emails sent in the period, what people did with them and the orders they earned (as the automation's results, D202); totals for the period and the one before. Rates are left to the reader: opens, clicks, unsubscribes and orders of delivered emails, bounces of sent ones.