The dashboard: what email brought in a period
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 and automations by revenue; and each connected email provider’s sending health. `storeId` narrows orders and revenue to one store. Without `from` it covers all time, with nothing to compare.
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 and automations by revenue; and each connected email provider’s sending health. storeId narrows orders and revenue to one store. Without from it covers all time, with nothing to compare.
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
uuidOK
application/json- response
from*|date-timeto*stringdate-timeprevious*|nullbucket*string"day""week""month"timeZone*stringrevenue*array<>orders*emails*subscribers*series*array<>topCampaigns*array<>topAutomations*array<>curl -X GET 'https://api.postforge.dev/v1/analytics/overview'{ "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": { "email": 0, "store": 0 } } ], "orders": { "email": 0, "store": 0, "previous": { "email": 0, "store": 0 } }, "emails": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0, "previous": { "sent": 0, "delivered": 0, "opened": 0, "clicked": 0 } }, "subscribers": { "subscribed": 0, "unsubscribed": 0, "total": 0, "previous": { "subscribed": 0, "unsubscribed": 0 } }, "series": [ { "at": "2019-08-24T14:15:22Z", "revenue": [ { "currency": "string", "campaigns": 0, "automations": 0 } ], "subscribed": 0, "unsubscribed": 0 } ], "topCampaigns": [ { "id": "string", "name": "string", "sentAt": "2019-08-24T14:15:22Z", "delivered": 0, "opened": 0, "clicked": 0, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ] } ], "topAutomations": [ { "id": "string", "name": "string", "sent": 0, "delivered": 0, "clicked": 0, "orders": 0, "revenue": [ { "currency": "string", "amount": 0, "orders": 0 } ] } ]}