Retrieve an ecommerce revenue summary

Revenue for completed and recovered ecommerce orders in a date window: the order count and the number of distinct customers who placed them, broken down by currency and, when no connectionId is given, by connection (store). Already-formatted money strings are returned beside the raw amounts. Orders in any other state, such as abandoned or pending carts, are not counted; use the order status summary for those. A window of orders is chosen by the date the order was created in the store, not the date it reached ActiveCampaign. Counts and raw amounts are returned as numeric strings, exactly as the database reports them.

Query Params
date

First day of the window, as YYYY-MM-DD, counted from 00:00:00. Send it together with endDate or not at all. When both are omitted the window is the last 30 days.

date

Last day of the window, as YYYY-MM-DD, counted through 23:59:59. Send it together with startDate or not at all, and never before startDate. When both are omitted the window ends today.

string

Restrict the result to one ecommerce connection (store) by its id, as listed by GET /connections. A positive integer. When omitted the result covers every connection.

string
^[A-Z]{3}$

Restrict the result to one currency, as a three-letter upper-case ISO 4217 code such as USD. When omitted every currency is included and reported separately.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json