Customers

Customers with lifetime spend and order statistics.

30 fields — 23 dimensions, 7 metrics. Date clauses (SINCE, UNTIL, DURING) use firstOrderDate.

The live, authoritative list is always GET /v1/datasets — this page is regenerated from the same catalog, but the endpoint reflects exactly what is deployed.

Query it

FROM customers
  SHOW customer_count
  GROUP BY customer_name
  SINCE -30d

See Querying with SoloQL for the language.

Fetch records

curl -H "Authorization: Bearer esk_live_..." \
  "https://api.ecomsolo.com/v1/customers?page_size=50&fields=customer_name,customer_email,customer_id"

Any field marked ✅ below can be returned, requested via fields=, and used as an equality filter (?field=value). Fields marked aggregate only exist for COUNT-style questions and have no value on a single record — ask SoloQL for those. See Fetching records.

Fields

FieldTypeRoleRecordsDescription
customer_namestringdimensionCustomer display name.
customer_emailstringdimensionEmail address of the customer.
customer_idstringdimensionShopify identifier for the customer.
first_namestringdimensionCustomer first name.
last_namestringdimensionCustomer last name.
customer_account_statusstringdimensionStatus of the customer's account.
customer_languagestringdimensionLanguage associated with the customer.
customer_tagstringdimensionTag associated with the customer.
tax_exemptbooleandimensionWhether the customer is tax exempt.
verified_emailbooleandimensionWhether the email address is verified.
customer_email_subscription_statusstringdimensionEmail marketing subscription status of the customer.
customer_sms_subscription_statusstringdimensionSMS marketing subscription status of the customer.
customer_added_datedatedimensionDate the customer record was added.
customer_first_order_datedatedimensionDate of the customer's first order.
customer_last_order_datedatedimensionDate of the customer's most recent order.
customer_number_of_ordersnumberdimensionNumber of orders the customer has placed across all time.
customer_amount_spentmoneydimensionAmount the customer has spent across all time.
predicted_spend_tierstringdimensionShopify's prediction of how much the customer is likely to spend, as a tier.
rfm_groupstringdimensionShopify's recency/frequency/monetary grouping of the customer (Champions, Loyal, At risk, …).
customer_citystringdimensionIndividual cities in the customer's history of addresses.
customer_regionstringdimensionIndividual regions in the customer's history of addresses.
customer_countrystringdimensionIndividual countries in the customer's history of addresses.
customer_countnumbermetricaggregate onlyNumber of customers in the group (document count — value_count on createdAt). Sums across stores.
new_customer_recordsnumbermetricaggregate onlyNumber of customers whose first purchase is within the period. Sums across stores.
total_number_of_ordersnumbermetricNumber of orders the customer has placed across all time.
total_amount_spentmoneymetricAmount the customer has spent across all time.
total_amount_spent_per_ordermoneymetricaggregate onlyAverage amount spent per order — total amount spent divided by total number of orders.
percent_of_customerspercentmetricaggregate onlyEach group's customer count as a percentage of all customers matching the query.
days_since_last_ordernumbermetricAverage days since the customers' most recent order. Customers with no orders are excluded.
storestringdimensionThe shop the record belongs to. Filter with WHERE store IN ('Shop name') or GROUP BY store.