How email performed in a period
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.
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.
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
OK
application/json- response
from*|date-timeto*stringdate-timeprevious*|nullbucket*string"day""week""month"timeZone*stringrevenue*array<>orders*emails*series*array<>previousSeries*array<>|nulllocales*array<>curl -X GET 'https://api.postforge.dev/v1/analytics/report'{ "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "previous": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "bucket": "day", "timeZone": "string", "revenue": [ { "currency": "string", "campaigns": 0, "automations": 0, "store": 0, "previous": { "campaigns": 0, "automations": 0, "store": 0 } } ], "orders": { "campaigns": 0, "automations": 0, "store": 0, "previous": { "campaigns": 0, "automations": 0, "store": 0 } }, "emails": { "campaigns": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "automations": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "previous": { "campaigns": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "automations": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 } } }, "series": [ { "at": "2019-08-24T14:15:22Z", "emails": { "campaigns": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "automations": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 } }, "orders": { "campaigns": 0, "automations": 0 }, "revenue": [ { "currency": "string", "campaigns": 0, "automations": 0 } ] } ], "previousSeries": [ { "at": "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 } ] } ], "locales": [ { "locale": "string", "emails": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "unsubscribed": 0, "bounced": 0, "complained": 0 }, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ] } ]}The dashboard: what email brought in a period GET
Read live (D208): revenue per currency from campaigns, automations and the whole store, orders, emails sent with people’s opens and clicks, subscribes and unsubscribes, each against the as long period before it; a series per day, week or month in the workspace’s time zone; the top five campaigns (sent in the period) and automations (emailing in it) by what those emails earned. `storeId` narrows orders and revenue to one store. Without `from` it covers all time, with nothing to compare.
Campaigns sent in a period and what they earned GET
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.