Retrieve an ecommerce customer behavior summary

Customers with completed or recovered orders in a date window, split per connection (store) into new (one order in the window), repeat (more than one order in the window) and inactive (latest order in the window is more than 90 days before the end of the window). Inactivity is measured from endDate, not from today, and only orders inside the window are looked at, so a window of 90 days or less, including the default 30-day window, never has inactive customers. The three groups do not overlap, so they add up to that connection total_customers. Because a customer who shops at two stores is counted once for each, the grand total_customers is not a count of distinct people. Pass behaviorType to add figures for one group.

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
enum

Add additional_metrics for one group: repeat_customers, new_customers or inactive_customers. When omitted there is no additional_metrics.

Allowed:
Responses

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